twitter_friendly 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 687792a2d0065ebefe3b95ad38f1df4558a644f0c07819619961dd85f4b7fa7c
-  data.tar.gz: ec86328550855e0f864daea0f3ab8bbfadf25cc71e217cda7d794c1d3eb52a2b
+  metadata.gz: 810019b532f5f365b544ca6e0a0066717794b8975b59ae0a840b74f44377bff6
+  data.tar.gz: 75f3b7052fa926da7457b53f71d0f2f6e08496efd02042750681678b53d351dd
 SHA512:
-  metadata.gz: b3029c832c6da171bedcd7a9a82e2c211e2be912913deed15d6a32ff4d2884f18d4b990ec8f902f4e97dcd684815a59c13a7f0f5e95e6134dc2043e343d43430
-  data.tar.gz: 36365cf299fab85c22859303652963185700c967023a558b7f16f1b289b6b563ccc32ed6f014d48d8383bf0beb3438c102fe9d43e0b34e42c964cec57f650db5
+  metadata.gz: '08a9a4ef337d993f1cb3bb6689df73d67b5adc74576214206774c5dc2b720e0ef66c30a376c2d122c4a70d7dc85661f6114508ad0e030819f52a0c65370a3033'
+  data.tar.gz: f26d6b48033db9dc96752a55c12a5e7ffe1c3610773f0014af8d1a69b4c84384de5eec858c204634212c1e205b2579ec6cf689a8dd0cdf634031a65510520ca4

data/.gitignore

@@ -7,8 +7,8 @@
 /spec/reports/
 /tmp/
 
-*.log
 /.pryrc
 /.env
-/.twitter_friendly
+/log/
+/cache/
 /.idea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitter_friendly (1.2.0)
+    twitter_friendly (1.2.1)
       activesupport (>= 4.2, < 6.0)
       oj (~> 3.7.6)
       parallel (~> 1.12.1)

data/README.md

@@ -5,16 +5,16 @@
 
 The twitter_friendly is a gem to crawl many friends/followers with minimal code. When you want to get a list of friends/followers for a user, all you need to write is the below.
 
-```
+```ruby
 require 'twitter_friendly'
 
 client =
     TwitterFriendly::Client.new(
-        consumer_key: 'CONSUMER_KEY',
-        consumer_secret: 'CONSUMER_SECRET',
-        access_token: 'ACCESS_TOKEN',
+        consumer_key:        'CONSUMER_KEY',
+        consumer_secret:     'CONSUMER_SECRET',
+        access_token:        'ACCESS_TOKEN',
         access_token_secret: 'ACCESS_TOKEN_SECRET',
-        expires_in: 86400 # 1day
+        expires_in:          86400 # 1day
     )
 
 ids = []
@@ -22,7 +22,8 @@ ids = []
 begin
   ids = client.follower_ids('yousuck2020')
 rescue Twitter::Error::TooManyRequests => e
-  sleep client.rate_limit.follower_ids[:reset_in]
+  seconds = e.rate_limit.reset_in.to_i # or client.rate_limit.follower_ids[:reset_in]
+  sleep seconds
   retry
 end
 
@@ -44,13 +45,13 @@ gem 'twitter_friendly'
 
 And then execute:
 
-```sh
+```bash
 $ bundle
 ```
 
 Or install it yourself as:
 
-```sh
+```bash
 $ gem install twitter_friendly
 ```
 
@@ -58,7 +59,7 @@ $ gem install twitter_friendly
 
 You can pass configuration options as a block to `TwitterFriendly::Client.new` just like the below.
 
-```
+```ruby
 client = TwitterFriendly::Client.new do |config|
   config.consumer_key        = "YOUR_CONSUMER_KEY"
   config.consumer_secret     = "YOUR_CONSUMER_SECRET"

data/lib/twitter_friendly/cache.rb

@@ -9,37 +9,35 @@ module TwitterFriendly
     def initialize(*args)
       options = {expires_in: 1.hour, race_condition_ttl: 5.minutes}.merge(args.extract_options!)
 
-      path = options[:cache_dir] || File.join('.twitter_friendly', 'cache')
+      path = options[:cache_dir] || File.join('cache')
       FileUtils.mkdir_p(path) unless File.exists?(path)
       @client = ::ActiveSupport::Cache::FileStore.new(path, options)
     end
 
-    # @param key [String]
-    #
-    # @option serialize_options [Array] :args
-    def fetch(key, serialize_options, &block)
+    def fetch(key, args:, &block)
       block_result = nil
-      yield_and_encode =
-          Proc.new do
-            block_result = yield
-            encode(block_result, serialize_options)
-          end
+      yield_and_encode = Proc.new do
+        block_result = yield
+        encode(block_result, args: args)
+      end
+
+      # 目的のデータがキャッシュになかった場合、キャッシュにはシリアライズしたJSONを保存しつつ、
+      # このメソッドの呼び出し元にはJSONにシリアライズする前の結果を返している。
+      # こうしないと、不要なデコードをすることになってしまう。
 
       fetch_result = @client.fetch(key, &yield_and_encode)
 
-      block_result || decode(fetch_result, serialize_options)
+      block_result || decode(fetch_result, args: args)
     end
 
     private
 
-    # @option options [Array] :args
-    def encode(obj, options)
-      Serializer.encode(obj, options)
+    def encode(obj, args:)
+      Serializer.encode(obj, args: args)
     end
 
-    # @option options [Array] :args
-    def decode(str, options)
-      Serializer.decode(str, options)
+    def decode(str, args:)
+      Serializer.decode(str, args: args)
     end
   end
 end

data/lib/twitter_friendly/caching_and_logging.rb

@@ -39,18 +39,18 @@ module TwitterFriendly
 
       module_function
 
-      def start_processing(operation, options)
-        payload = {operation: operation}.merge(options)
+      def start_processing(method_name, options)
+        payload = {operation: method_name}.merge(options)
         ::ActiveSupport::Notifications.instrument('start_processing.twitter_friendly', payload) {}
       end
 
-      def complete_processing(operation, options)
-        payload = {operation: operation}.merge(options)
+      def complete_processing(method_name, options)
+        payload = {operation: method_name}.merge(options)
         ::ActiveSupport::Notifications.instrument('complete_processing.twitter_friendly', payload) { yield(payload) }
       end
 
-      def perform_request(caller, options, &block)
-        payload = {operation: 'request', args: [caller, options]}
+      def perform_request(method_name, options, &block)
+        payload = {operation: 'request', args: [method_name, options]}
         ::ActiveSupport::Notifications.instrument('request.twitter_friendly', payload) { yield(payload) }
       end
     end

data/lib/twitter_friendly/client.rb

@@ -26,12 +26,14 @@ module TwitterFriendly
 
     def initialize(*args)
       options = args.extract_options!
-      @twitter = Twitter::REST::Client.new(options.slice(:access_token, :access_token_secret, :consumer_key, :consumer_secret))
 
+      @twitter = Twitter::REST::Client.new(options.slice(:access_token, :access_token_secret, :consumer_key, :consumer_secret))
       options.except!(:access_token, :access_token_secret, :consumer_key, :consumer_secret)
-      @cache = TwitterFriendly::Cache.new(options)
 
-      @logger = TwitterFriendly::Logger.new(options)
+      @cache = TwitterFriendly::Cache.new(options.slice(:cache_dir, :expires_in, :race_condition_ttl))
+      options.except!(:cache_dir, :expires_in, :race_condition_ttl)
+
+      @logger = TwitterFriendly::Logger.new(options.slice(:log_dir, :log_level))
 
       unless subscriber_attached?
         if @logger.level == ::Logger::DEBUG

data/lib/twitter_friendly/log_subscriber.rb

@@ -1,6 +1,7 @@
 module TwitterFriendly
   module Logging
     def truncated_payload(payload)
+      return '' if payload.empty?
       return payload.inspect if !payload.has_key?(:args) || !payload[:args].is_a?(Array) || payload[:args].empty? || !payload[:args][0].is_a?(Array)
 
       args = payload[:args].dup
@@ -30,24 +31,28 @@ module TwitterFriendly
     include Logging
 
     def start_processing(event)
-      debug do
+      info do
         payload = event.payload
-        name = "TF::Started #{payload[:operation]}"
+        operation = payload.delete(:operation)
 
         if payload[:super_operation]
-          "#{name} in #{payload[:super_operation][0]} at #{Time.now}"
+          "TF::Started #{operation} in #{payload[:super_operation][0]} at #{Time.now}"
         else
-          "#{name} at #{Time.now}"
+          "TF::Started #{operation} at #{Time.now}"
         end
       end
     end
 
     def complete_processing(event)
-      debug do
+      info do
         payload = event.payload
-        name = "TF::Completed #{payload[:operation]} in #{event.duration.round(1)}ms"
+        operation = payload.delete(:operation)
 
-        "#{name}#{" #{truncated_payload(payload)}" unless payload.empty?}"
+        if payload.empty?
+          "TF::Completed #{operation} in #{event.duration.round(1)}ms"
+        else
+          "TF::Completed #{operation} in #{event.duration.round(1)}ms #{truncated_payload(payload)}"
+        end
       end
     end
 
@@ -66,11 +71,19 @@ module TwitterFriendly
       debug do
         payload = event.payload
         payload.delete(:name)
-        operation = payload.delete(:operation)
-        name = "  TW::#{operation.capitalize} #{payload[:args][0] if payload[:args]&.is_a?(Array)} (#{event.duration.round(1)}ms)"
-        c = (%i(encode decode).include?(operation.to_sym)) ? YELLOW : CYAN
+        operation = payload.delete(:operation).capitalize
+        args = payload[:args]
+        method_name = args.shift
+
+        name = "  TW::#{operation} #{method_name} (#{event.duration.round(1)}ms)"
+        c = (%i(Encode Decode).include?(operation.to_sym)) ? YELLOW : CYAN
         name = color(name, c, true)
-        "  #{name}#{" #{payload[:args][1] if payload[:args]&.is_a?(Array)}" unless payload.empty?}"
+
+        if args.size == 1 && args[0].is_a?(Hash) && args[0].empty?
+          "  #{name}"
+        else
+          "  #{name} #{args[1]}"
+        end
       end
     end
 

data/lib/twitter_friendly/logger.rb

@@ -8,7 +8,7 @@ module TwitterFriendly
     def_delegators :@logger, :debug, :info, :warn, :error, :fatal, :level
 
     def initialize(options = {})
-      path = options[:log_dir] || File.join('.twitter_friendly')
+      path = options[:log_dir] || File.join('log')
       FileUtils.mkdir_p(path) unless File.exists?(path)
 
       @logger = ::Logger.new(File.join(path, 'twitter_friendly.log'))

data/lib/twitter_friendly/rest/users.rb

@@ -3,8 +3,8 @@ require 'parallel'
 module TwitterFriendly
   module REST
     module Users
-      def verify_credentials(options = {})
-        @twitter.verify_credentials({skip_status: true}.merge(options))&.to_hash
+      def verify_credentials(include_entities: false, skip_status: true, include_email: true)
+        @twitter.verify_credentials(include_entities: include_entities, skip_status: skip_status, include_email: include_email)&.to_hash
       end
 
       def user?(*args)
@@ -19,9 +19,9 @@ module TwitterFriendly
 
       def users(values, options = {})
         if values.size <= MAX_USERS_PER_REQUEST
-          @twitter.users(values, options)
+          @twitter.users(values, options).map(&:to_h)
         else
-          parallel(in_threads: 10) do |batch|
+          parallel(in_threads: 6) do |batch|
             values.each_slice(MAX_USERS_PER_REQUEST) { |targets| batch.users(targets, options) }
           end.flatten
         end

data/lib/twitter_friendly/serializer.rb

@@ -4,14 +4,14 @@ require 'oj'
 module TwitterFriendly
   class Serializer
     class << self
-      def encode(obj, options = {})
-        Instrumenter.perform_encode(options) do
+      def encode(obj, args:)
+        Instrumenter.perform_encode(args: args) do
           (!!obj == obj) ? obj : coder.encode(obj)
         end
       end
 
-      def decode(str, options = {})
-        Instrumenter.perform_decode(options) do
+      def decode(str, args:)
+        Instrumenter.perform_decode(args: args) do
           str.kind_of?(String) ? coder.decode(str) : str
         end
       end
@@ -31,13 +31,13 @@ module TwitterFriendly
 
       module_function
 
-      def perform_encode(options, &block)
-        payload = {operation: 'encode', args: options[:args]}
+      def perform_encode(args:, &block)
+        payload = {operation: 'encode', args: args}
         ::ActiveSupport::Notifications.instrument('encode.twitter_friendly', payload) { yield(payload) }
       end
 
-      def perform_decode(options, &block)
-        payload = {operation: 'decode', args: options[:args]}
+      def perform_decode(args:, &block)
+        payload = {operation: 'decode', args: args}
         ::ActiveSupport::Notifications.instrument('decode.twitter_friendly', payload) { yield(payload) }
       end
     end

data/lib/twitter_friendly/version.rb

@@ -1,3 +1,3 @@
 module TwitterFriendly
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_friendly
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - ts-3156
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport