twitter-cache 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67e756e9a5226e0a5993f3659270a04034ccae3d
-  data.tar.gz: 82f7eadc1bac46efc939d79ab6d84264cc248603
+  metadata.gz: b33820ed5e0c4c0de73bc2d7d9e5bd66e25ebb42
+  data.tar.gz: 6d1004ae84dc7b09acb2cd6c251dc141fae73f12
 SHA512:
-  metadata.gz: 0139115cd127a1f20f29317487f5b84ad6489b85f1e1e96cfe651a92b9351a073aa264fbd157792f127d6a426f9f3d78add41b868500be3c9f1a605f8208b00d
-  data.tar.gz: 42f8ae1c30b9b24357c502c847642ea0779f1ea9b9c309ad362b2269d9d537052c6535b321a207a44f9c0ceda2bed7e99a38e04c204b4e87635d0ecdfc0ab074
+  metadata.gz: 66522d777898e8a9744f613c3ee813e88ae7afc09cb0871279ec376e5d220479464af1034fe827a55d16c3a0f9ea74682762183f1d2b5ec74c58f98409a64b00
+  data.tar.gz: ace040c32cb309cc327948b3ae558fe05a96772da881fcc5fb8b2f30119e4716730033c8bb42fc80b5d5139481f21608510b66e2bdbf96c2c6df94e5fb4c5a73

data/README.md

@@ -24,12 +24,9 @@ Or install it yourself as:
 
 ```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.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)
@@ -39,35 +36,24 @@ end
 
 ### Usage
 
-Unauthorized client:
+create cache client
 
 ```ruby
-twitter = TwitterCache::Client.new
-```
-
-Authorized client:
-
-```ruby
-twitter = TwitterCache::Client.new(access_token: 'token', access_token_secret: 'secret')
-
-# or with block
-
-twitter = TwitterCache::Client.new do |c|
-  c.access_token = 'token'
-  c.access_token_secret = 'secret'
-end
+twitter = Twitter::REST::Client.new(consumer_key: 'key', ...)
+cache = Twitter::Cache.new(twitter)
 ```
 
 Get friends:
 
 ```ruby
+
 # for authorized user
-twitter.friends(per: 200, page: 1)
-twitter.friends(per: 200, page: :randam)
+cache.friends(per: 200, page: 1)
+cache.friends(per: 200, page: :randam)
 
 # for other user
-twitter.friends(123456, per: 200, page: 1)
-twitter.friends(123456, per: 200, page: :random)
+cache.friends(123456, per: 200, page: 1)
+cache.friends(123456, per: 200, page: :random)
 ```
 
 ## Development

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/twitter/cache/config.rb

@@ -0,0 +1,20 @@
+module Twitter
+  module Cache
+    class Config
+      attr_accessor :redis, :ttl, :namespace
+
+      def namespace
+        @namespace ||= 'twitter-cache-gem'
+      end
+
+      def user_instance(&block)
+        @user_instance = block
+      end
+
+      def convert_user(raw)
+        return raw unless @user_instance
+        @user_instance.call(raw)
+      end
+    end
+  end
+end

data/lib/twitter/cache/helpers.rb

@@ -0,0 +1,13 @@
+module Twitter
+  module Cache
+    module Helpers
+      def config
+        Twitter::Cache.config
+      end
+
+      def cache
+        @cache ||= Twitter::Cache::Redis.new
+      end
+    end
+  end
+end

data/lib/twitter/cache/redis.rb

@@ -0,0 +1,36 @@
+require 'redis-namespace'
+require 'oj'
+
+module Twitter
+  module Cache
+    class Redis
+      include Twitter::Cache::Helpers
+      attr_reader :client
+
+      def initialize
+        redis_url = ENV['REDIS_URL'] || config.redis
+        redis = ::Redis.new(url: redis_url)
+        @client = ::Redis::Namespace.new(config.namespace, 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(key, ttl) if ttl
+      end
+    end
+  end
+end

data/lib/twitter/cache/version.rb

@@ -0,0 +1,5 @@
+module Twitter
+  module Cache
+    VERSION = '0.2.0'
+  end
+end

data/lib/twitter/cache/wrapper.rb

@@ -0,0 +1,67 @@
+module Twitter
+  module Cache
+    class Wrapper
+      include Twitter::Cache::Helpers
+      attr_reader :twitter
+
+      def initialize(twitter)
+        @twitter = twitter
+      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
+
+      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
+end

data/lib/twitter/cache.rb

@@ -0,0 +1,22 @@
+require 'twitter/cache/version'
+require 'twitter/cache/helpers'
+require 'twitter/cache/config'
+require 'twitter/cache/redis'
+require 'twitter/cache/wrapper'
+
+module Twitter
+  module Cache
+    def self.configure
+      yield(config)
+      config.freeze
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.new(twitter)
+      Twitter::Cache::Wrapper.new(twitter)
+    end
+  end
+end

data/lib/twitter-cache.rb

@@ -1 +1 @@
-require 'twitter_cache'
+require 'twitter/cache'

data/twitter-cache.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'twitter_cache/version'
+require 'twitter/cache/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'twitter-cache'
-  spec.version       = TwitterCache::VERSION
+  spec.version       = Twitter::Cache::VERSION
   spec.authors       = ['masarakki']
   spec.email         = ['masaki@hisme.net']
 
@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
 
   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|
+  %w(rspec rubocop guard guard-rspec guard-rubocop rspec-its activemodel coveralls pry).each do |gem|
     spec.add_development_dependency gem
   end
 
-  %w(twitter redis-namespace oj).each do |gem|
+  %w(redis-namespace oj).each do |gem|
     spec.add_dependency gem
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - masarakki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !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
@@ -178,34 +164,6 @@ dependencies:
     - - ">="
       - !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
@@ -253,12 +211,12 @@ files:
 - 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
+- lib/twitter/cache.rb
+- lib/twitter/cache/config.rb
+- lib/twitter/cache/helpers.rb
+- lib/twitter/cache/redis.rb
+- lib/twitter/cache/version.rb
+- lib/twitter/cache/wrapper.rb
 - twitter-cache.gemspec
 homepage: https://github.com/masarakki/twitter-cache
 licenses:

data/lib/twitter_cache/client.rb

@@ -1,82 +0,0 @@
-require 'twitter'
-
-module TwitterCache
-  class Client
-    include TwitterCache::Helpers
-    attr_accessor :access_token, :access_token_secret
-
-    def initialize(access_token: nil, access_token_secret: nil)
-      @access_token = access_token
-      @access_token_secret = access_token_secret
-      yield(self) if block_given?
-    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) do |conf|
-        if token_given?
-          conf.access_token = access_token
-          conf.access_token_secret = access_token_secret
-        end
-      end
-    end
-
-    protected
-
-    def token_given?
-      access_token && access_token_secret
-    end
-
-    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

@@ -1,14 +0,0 @@
-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

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

data/lib/twitter_cache/redis.rb

@@ -1,34 +0,0 @@
-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

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

data/lib/twitter_cache.rb

@@ -1,16 +0,0 @@
-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