twitter-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a83a641108791a5a3691a56ccae188dbb41762ac
+  data.tar.gz: 92d8d426440bcaf8dae90b22aa8a1cfa35f99112
+SHA512:
+  metadata.gz: 72c516252444d1331c5de0e09281261db8de3d43a8440e1dd042b576c0e449ae82f7a2875811fe3fb0a50a84d89528c90501789fa0f61b531b2ec537e2fd0187
+  data.tar.gz: 2e3d64e0477a01912e63de74b43c7347303d30d3f550f37f8e01fed06c83fbae3343f68262634c4ecb66fa24252b531588b9081aeb260b608c457ca2b24a16cc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Exclude:
+    - twitter-cache.gemspec
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.2
+env:
+  - CONSUMER_KEY=key CONSUMER_SECRET=secret ACCESS_TOKEN=token ACCESS_TOKEN_SECRET=token_secret
+services:
+  - redis
+script:
+  - bundle exec rake spec
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitter-cache.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,17 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop, cli: '--auto-correct' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 masarakki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# 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.twitter = {
+    consumer_key: 'CONSUMER_KEY',
+    consumer_secret: 'CONSUMER_SECRET'
+  }
+  config.redis = 'redis://127.0.0.1:6379/' # default ENV['REDIS_URL']
+  config.ttl = 60 * 30                     # sec
+  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
+
+```ruby
+twitter = TwitterCache::Client.new
+# or with authorization
+twitter = TwitterCache::Client.new(access_token: 'token', access_token_secret: 'secre
+t')
+
+# for authorized user
+twitter.friends(per: 200, page: 1)
+twitter.friends(per: 200, page: :randam)
+
+# for other user
+twitter.friends(123456, per: 200, page: 1)
+twitter.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

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'twitter-cache'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'dotenv'
+Dotenv.load
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twitter-cache.rb

@@ -0,0 +1 @@
+require 'twitter_cache'

data/lib/twitter_cache.rb

@@ -0,0 +1,16 @@
+require 'twitter_cache/version'
+require 'twitter_cache/helpers'
+require 'twitter_cache/config'
+require 'twitter_cache/redis'
+require 'twitter_cache/client'
+
+module TwitterCache
+  def self.configure
+    yield(config)
+    config.freeze
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/twitter_cache/client.rb

@@ -0,0 +1,71 @@
+require 'twitter'
+
+module TwitterCache
+  class Client
+    include TwitterCache::Helpers
+    attr_reader :tokens
+
+    def initialize(tokens = nil)
+      @tokens = tokens
+    end
+
+    def user(id = current_id)
+      cache.get(user_key(id), ttl: config.ttl) do
+        config.convert_user(twitter.user(id))
+      end
+    end
+
+    def friend_ids(id = current_id)
+      cache.get(friends_key(id), ttl: config.ttl) do
+        twitter.friend_ids(id).to_a
+      end
+    end
+
+    def friends(id = current_id, per: 100, page: 0)
+      ids = friend_ids(id)
+      case page
+      when :rand, :random
+        users(ids.sample(per))
+      else
+        start = per * page
+        users(ids[start, per])
+      end
+    end
+
+    def users(ids)
+      users = ids.map { |id| cache.get(user_key(id)) }.compact
+      return users if ids.count == users.count
+      fetch_users(ids)
+    end
+
+    def current_user
+      @current_user ||= twitter.current_user
+    end
+
+    def current_id
+      current_user.id
+    end
+
+    def twitter
+      @twitter ||= ::Twitter::REST::Client.new(config.twitter.dup.merge(tokens))
+    end
+
+    protected
+
+    def user_key(id)
+      "user:#{id}"
+    end
+
+    def friends_key(id)
+      "friends:#{id}"
+    end
+
+    def fetch_users(ids)
+      users = twitter.users(ids).map { |raw| config.convert_user(raw) }
+      users.each do |user|
+        cache.set(user_key(user.id), user, ttl: config.ttl)
+      end
+      users
+    end
+  end
+end

data/lib/twitter_cache/config.rb

@@ -0,0 +1,14 @@
+module TwitterCache
+  class Config
+    attr_accessor :twitter, :redis, :ttl
+
+    def user_instance(&block)
+      @user_instance = block
+    end
+
+    def convert_user(raw)
+      return raw unless @user_instance
+      @user_instance.call(raw)
+    end
+  end
+end

data/lib/twitter_cache/helpers.rb

@@ -0,0 +1,11 @@
+module TwitterCache
+  module Helpers
+    def config
+      TwitterCache.config
+    end
+
+    def cache
+      @cache ||= TwitterCache::Redis.new
+    end
+  end
+end

data/lib/twitter_cache/redis.rb

@@ -0,0 +1,34 @@
+require 'redis-namespace'
+require 'oj'
+
+module TwitterCache
+  class Redis
+    include TwitterCache::Helpers
+    attr_reader :client
+
+    def initialize
+      redis_url = ENV['REDIS_URL'] || config.redis
+      redis = ::Redis.new(url: redis_url)
+      @client = ::Redis::Namespace.new(:twitter_cache_gem, redis: redis)
+    end
+
+    def method_missing(name, *args)
+      client.send(name, *args)
+    end
+
+    def get(key, ttl: nil)
+      stored = client.get(key)
+      return Oj.load(stored, symbolize_keys: true) if stored
+      return nil unless block_given?
+
+      value = yield
+      set(key, value, ttl: ttl)
+      value
+    end
+
+    def set(key, value, ttl: nil)
+      client.set(key, Oj.dump(value))
+      client.expire(ttl) if ttl
+    end
+  end
+end

data/lib/twitter_cache/version.rb

@@ -0,0 +1,3 @@
+module TwitterCache
+  VERSION = '0.1.0'
+end

data/twitter-cache.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twitter-cache'
+  spec.version       = TwitterCache::VERSION
+  spec.authors       = ['masarakki']
+  spec.email         = ['masaki@hisme.net']
+
+  spec.summary       = 'easy access and cache twitter friends'
+  spec.description   = 'easy access and cache twitter friends'
+  spec.homepage      = 'https://github.com/masarakki/twitter-cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  %w(rspec rubocop guard guard-rspec guard-rubocop rspec-its activemodel coveralls webmock pry dotenv).each do |gem|
+    spec.add_development_dependency gem
+  end
+
+  %w(twitter redis-namespace oj).each do |gem|
+    spec.add_dependency gem
+  end
+end

metadata

@@ -0,0 +1,287 @@
+--- !ruby/object:Gem::Specification
+name: twitter-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masarakki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: easy access and cache twitter friends
+email:
+- masaki@hisme.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitter-cache.rb
+- lib/twitter_cache.rb
+- lib/twitter_cache/client.rb
+- lib/twitter_cache/config.rb
+- lib/twitter_cache/helpers.rb
+- lib/twitter_cache/redis.rb
+- lib/twitter_cache/version.rb
+- twitter-cache.gemspec
+homepage: https://github.com/masarakki/twitter-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: easy access and cache twitter friends
+test_files: []