Sha256: 001e8a007cfb5473f43e5ce0f531be9190a1c858b35b50ff587dd9d0632d056f

Contents?: true

Size: 1.77 KB

Versions: 4

Compression:

Stored size: 1.77 KB

Contents

# TwitterCache

easy access and cache to twitter friends.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'twitter-cache'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install twitter-cache

## Usage

### Setup

```ruby
TwitterCache.configure do |config|
  config.redis = 'redis://127.0.0.1:6379/' # default: ENV['REDIS_URL']
  config.ttl = 60 * 30                     # sec
  config.namespace = 'myapp'               # default: twitter-cache-gem
  config.user_instance do |raw|
    User.new(id: raw.id, nickname: raw.screen_name,
             image: raw.profile_image_url_https.to_s)
  end
end
```

### Usage

create cache client

```ruby
twitter = Twitter::REST::Client.new(consumer_key: 'key', ...)
cache = Twitter::Cache.new(twitter)
```

Get friends:

```ruby

# for authorized user
cache.friends(per: 200, page: 1)
cache.friends(per: 200, page: :randam)

# for other user
cache.friends(123456, per: 200, page: 1)
cache.friends(123456, per: 200, page: :random)
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/masarakki/twitter_friends/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
twitter-cache-0.2.3 README.md
twitter-cache-0.2.2 README.md
twitter-cache-0.2.1 README.md
twitter-cache-0.2.0 README.md