twitter_tweet_bot 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b94a383f3116ec1bba1e7a9b4ba71bb33a2254ac07e988160887318bd46d0ed
-  data.tar.gz: 50f312230ac41ebc3976a5fe72aee63075a9f5d324c5ddd75c76e56e8ed9bcda
+  metadata.gz: 0075abce451f1cc89c2cfaf56d04c9a18c3a1ae4e9bed984c8ec1a582689a944
+  data.tar.gz: 8d37895dec281683bf51db107ac3b4f02894d53380d797a7ff98aab0aa6d78a0
 SHA512:
-  metadata.gz: 4be6f7dfa8be6655a9cab92678b0b0b520c4f6a81a7a941077d46ada12230d3973774c92c8036d8082f6f4d439513f0211208c1497ebd855ec60c6e600b51347
-  data.tar.gz: 77bf8955e70e25140bb3cda5232dc310a4436ccf0c53b05482202b0c4b5f90344580a6626ee171c428fb128c7783429bede1af59b12a2b3b544013c334cf5b6b
+  metadata.gz: '0969b67fe82425486264df739eec73b98945eb339e39588d2117831949ca5667c8a2da7a9098dd25fc16a78fdb5318a416ddce331c939c0e34cd4b8dd553ada4'
+  data.tar.gz: ef888edd3e082f7371148c2471ce0ea0fa82c89da230506511681d7880df388ed72c349a8ee879debe1f7ffe2d3e9b65bf8fa82a6228d040026e844dd08eab00

data/README.md

@@ -44,7 +44,7 @@ TwitterTweetBot.configure do |config|
   # Redirect URL After Authorization
   config.redirect_uri = 'https://example.com/twitter/callback'
   # Twitter's App Scopes with OAuth 2.0
-  config.scopes = ['tweet.read', 'tweet.write', 'users.read', 'offline.access']
+  config.scopes = %w[tweet.read tweet.write users.read offline.access]
 end
 ```
 
@@ -94,6 +94,14 @@ TwitterTweetBot.post_tweet(token.access_token, 'Yeah!')
 #   @text="Yeah!">
 ```
 
+##### With [some params](https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets)
+
+```rb
+TwitterTweetBot.post_tweet(token.access_token, 'Yeah! Yeah!') do |params|
+  params.reply = { in_reply_to_tweet_id: '*******************' }
+end
+```
+
 #### Ex. Refresh an access token (required `'offline.access'` in scopes)
 
 ```rb

data/lib/twitter_tweet_bot/api/params/boolean_param.rb

@@ -0,0 +1,13 @@
+module TwitterTweetBot
+  module API
+    module Params
+      module BooleanParam
+        def self.build(key, value)
+          return {} unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+          { key => value }
+        end
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/params/comma_separated_param.rb

@@ -0,0 +1,21 @@
+module TwitterTweetBot
+  module API
+    module Params
+      module CommaSeparatedParam
+        DELIMITER = ','.freeze
+
+        def self.build(key, value)
+          { key => formed_value(value) }
+        end
+
+        def self.formed_value(value)
+          return value unless value.is_a?(Array)
+
+          value.join(DELIMITER)
+        end
+
+        private_constant :DELIMITER
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/params/hash_param.rb

@@ -0,0 +1,13 @@
+module TwitterTweetBot
+  module API
+    module Params
+      module HashParam
+        def self.build(key, value)
+          return {} unless value.is_a?(Hash)
+
+          { key => value }
+        end
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/params/string_param.rb

@@ -0,0 +1,13 @@
+module TwitterTweetBot
+  module API
+    module Params
+      module StringParam
+        def self.build(key, value)
+          return {} unless value.is_a?(String)
+
+          { key => value }
+        end
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/params/tweet_params.rb

@@ -0,0 +1,53 @@
+require 'twitter_tweet_bot/api/params/boolean_param'
+require 'twitter_tweet_bot/api/params/string_param'
+require 'twitter_tweet_bot/api/params/hash_param'
+
+module TwitterTweetBot
+  module API
+    module Params
+      class TweetParams
+        private_class_method :new
+
+        # @yield [params]
+        # @yieldparam params [TwitterTweetBot::API::Params::TweetParams]
+        def self.build(&block)
+          new(&block).build
+        end
+
+        # @see https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets
+        AVAILABLE_PARAMS = {
+          for_super_followers_only: BooleanParam,
+          text: StringParam,
+          direct_message_deep_link: StringParam,
+          quote_tweet_id: StringParam,
+          reply_settings: StringParam,
+          geo: HashParam,
+          media: HashParam,
+          poll: HashParam,
+          reply: HashParam
+        }.freeze
+
+        # @yield [params]
+        # @yieldparam params [TwitterTweetBot::API::Params::TweetParams]
+        def initialize(&block)
+          block&.call(self)
+        end
+
+        def params
+          @params ||= {}
+        end
+        alias build params
+
+        private :params
+
+        AVAILABLE_PARAMS.each do |name, param_klass|
+          define_method("#{name}=") do |value|
+            params.merge!(param_klass.build(name, value))
+          end
+        end
+
+        private_constant :AVAILABLE_PARAMS
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/params/users_me_params.rb

@@ -0,0 +1,43 @@
+require 'twitter_tweet_bot/api/params/comma_separated_param'
+require 'twitter_tweet_bot/api/params/string_param'
+
+module TwitterTweetBot
+  module API
+    module Params
+      class UsersMeParams
+        private_class_method :new
+
+        # @yield [params]
+        # @yieldparam params [TwitterTweetBot::API::Params::UsersMeParams]
+        def self.build(&block)
+          new(&block).build
+        end
+
+        # @yield [params]
+        # @yieldparam params [TwitterTweetBot::API::Params::UsersMeParams]
+        def initialize(&block)
+          block&.call(self)
+        end
+
+        def params
+          @params ||= {}
+        end
+        alias build params
+
+        def expansions=(value)
+          params.merge!(StringParam.build('expansions', value))
+        end
+
+        def tweet_fields=(value)
+          params.merge!(CommaSeparatedParam.build('tweet.fields', value))
+        end
+
+        def user_fields=(value)
+          params.merge!(CommaSeparatedParam.build('user.fields', value))
+        end
+
+        private :params
+      end
+    end
+  end
+end

data/lib/twitter_tweet_bot/api/tweet.rb

@@ -1,4 +1,5 @@
 require 'twitter_tweet_bot/api/http'
+require 'twitter_tweet_bot/api/params/tweet_params'
 
 module TwitterTweetBot
   module API
@@ -9,19 +10,28 @@ module TwitterTweetBot
 
       API_ENDPOTNT = 'https://api.twitter.com/2/tweets'.freeze
 
-      def self.post(access_token:, text:, **)
-        new(access_token).post(text)
+      # @param [String] access_token
+      # @param [String] text
+      # @yield [params]
+      # @yieldparam params [TwitterTweetBot::API::Params::TweetParams]
+      def self.post(access_token:, text:, **, &block)
+        new(access_token).post(
+          Params::TweetParams.build do |params|
+            params.text = text
+            block&.call(params)
+          end
+        )
       end
 
       def initialize(access_token)
         @access_token = access_token
       end
 
-      def post(text)
+      def post(params)
         request(
           :post_json,
           API_ENDPOTNT,
-          { text: text },
+          params,
           bearer_authorization_header(access_token)
         )
       end

data/lib/twitter_tweet_bot/api/users_me.rb

@@ -1,4 +1,5 @@
 require 'twitter_tweet_bot/api/http'
+require 'twitter_tweet_bot/api/params/users_me_params'
 
 module TwitterTweetBot
   module API
@@ -9,19 +10,24 @@ module TwitterTweetBot
 
       API_ENDPOTNT = 'https://api.twitter.com/2/users/me'.freeze
 
-      def self.fetch(access_token:, fields:, **)
-        new(access_token).fetch(fields)
+      # @param [String] access_token
+      # @yield [params]
+      # @yieldparam params [TwitterTweetBot::API::Params::UsersMeParams]
+      def self.fetch(access_token:, **, &block)
+        new(access_token).fetch(
+          Params::UsersMeParams.build(&block)
+        )
       end
 
       def initialize(access_token)
         @access_token = access_token
       end
 
-      def fetch(fields)
+      def fetch(params)
         request(
           :get,
           API_ENDPOTNT,
-          fields,
+          params,
           bearer_authorization_header(access_token)
         )
       end

data/lib/twitter_tweet_bot/cache/configuration_ext.rb

@@ -2,7 +2,7 @@ require 'twitter_tweet_bot/cache/store'
 
 module TwitterTweetBot
   module Cache
-    module ConfigrationExt
+    module ConfigurationExt
       attr_accessor :cache_provider
       attr_writer :cache
 

data/lib/twitter_tweet_bot/cache.rb

@@ -6,7 +6,7 @@ require 'twitter_tweet_bot/cache/entity_ext'
 
 module TwitterTweetBot
   Client.prepend(Cache::ClientExt)
-  Configration.prepend(Cache::ConfigrationExt)
+  Configuration.prepend(Cache::ConfigurationExt)
 
   Entity::Authorization.include(Cache::EntityExt::Authorization)
   Entity::Token.include(Cache::EntityExt::Token)

data/lib/twitter_tweet_bot/client/api.rb

@@ -28,15 +28,15 @@ module TwitterTweetBot
         )
       end
 
-      def post_tweet(access_token, text)
+      def post_tweet(access_token, text, &block)
         TwitterTweetBot::API::Tweet.post(
-          **params_with_config(access_token: access_token, text: text)
+          **params_with_config(access_token: access_token, text: text), &block
         )
       end
 
-      def users_me(access_token, fields = {})
+      def users_me(access_token, &block)
         TwitterTweetBot::API::UsersMe.fetch(
-          **params_with_config(access_token: access_token, fields: fields)
+          **params_with_config(access_token: access_token), &block
         )
       end
 

data/lib/twitter_tweet_bot/{configration.rb → configuration.rb}

@@ -1,5 +1,5 @@
 module TwitterTweetBot
-  class Configration
+  class Configuration
     attr_accessor :name,
                   :client_id,
                   :client_secret,

data/lib/twitter_tweet_bot/entity/base.rb

@@ -7,28 +7,28 @@ module TwitterTweetBot
       extend ActiveSupport::Concern
 
       class_methods do
+        # @param [Array] fields
         def act_as_entity(*fields)
           class_attribute :fields,
                           instance_writer: false,
                           default: fields
 
-          attr_reader(*fields)
-        end
+          attr_reader :raw
 
-        def build(json)
-          new(json)
-        end
-      end
+          fields.each do |field|
+            define_method(field) { target_fields[field] }
+          end
 
-      def initialize(json)
-        initialize_fields!(Hash(json))
-      end
+          # @param [Hash] hash
+          define_method(:initialize) { |hash| @raw = Hash(hash) }
 
-      private
+          define_method(:target_fields) { raw }
+          private :target_fields
+        end
 
-      def initialize_fields!(hash)
-        fields.each do |field|
-          instance_variable_set(:"@#{field}", hash[field])
+        # @param [Hash] hash
+        def build(hash)
+          new(hash)
         end
       end
     end

data/lib/twitter_tweet_bot/entity/tweet.rb

@@ -11,8 +11,10 @@ module TwitterTweetBot
         :edit_history_tweet_ids
       )
 
-      def self.build(json)
-        super(Hash(json)[:data])
+      private
+
+      def target_fields
+        Hash(raw[:data])
       end
     end
   end

data/lib/twitter_tweet_bot/entity/user.rb

@@ -11,8 +11,10 @@ module TwitterTweetBot
         :username
       )
 
-      def self.build(json)
-        super(Hash(json)[:data])
+      private
+
+      def target_fields
+        Hash(raw[:data])
       end
     end
   end

data/lib/twitter_tweet_bot/version.rb

@@ -1,7 +1,7 @@
 module TwitterTweetBot
   module Version
     def self.current
-      Gem::Version.new('1.1.0')
+      Gem::Version.new('1.2.0')
     end
   end
 end

data/lib/twitter_tweet_bot.rb

@@ -1,18 +1,18 @@
 require 'twitter_tweet_bot/client'
-require 'twitter_tweet_bot/configration'
+require 'twitter_tweet_bot/configuration'
 require 'twitter_tweet_bot/version'
 
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/module/delegation'
 
 module TwitterTweetBot
-  NoConfigrationError = Class.new(StandardError).freeze
+  NoConfigurationError = Class.new(StandardError).freeze
 
   mattr_accessor :default_config
 
   class << self
     def configure(&block)
-      self.default_config = Configration.new(&block)
+      self.default_config = Configuration.new(&block)
     end
 
     def client(config = nil)
@@ -29,7 +29,7 @@ module TwitterTweetBot
     private
 
     def default_config!
-      default_config or raise NoConfigrationError
+      default_config or raise NoConfigurationError
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_tweet_bot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - SongCastle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,6 +42,12 @@ files:
 - lib/twitter_tweet_bot/api/http/get.rb
 - lib/twitter_tweet_bot/api/http/headers.rb
 - lib/twitter_tweet_bot/api/http/post.rb
+- lib/twitter_tweet_bot/api/params/boolean_param.rb
+- lib/twitter_tweet_bot/api/params/comma_separated_param.rb
+- lib/twitter_tweet_bot/api/params/hash_param.rb
+- lib/twitter_tweet_bot/api/params/string_param.rb
+- lib/twitter_tweet_bot/api/params/tweet_params.rb
+- lib/twitter_tweet_bot/api/params/users_me_params.rb
 - lib/twitter_tweet_bot/api/refresh_token.rb
 - lib/twitter_tweet_bot/api/tweet.rb
 - lib/twitter_tweet_bot/api/users_me.rb
@@ -57,7 +63,7 @@ files:
 - lib/twitter_tweet_bot/client.rb
 - lib/twitter_tweet_bot/client/api.rb
 - lib/twitter_tweet_bot/client/entity.rb
-- lib/twitter_tweet_bot/configration.rb
+- lib/twitter_tweet_bot/configuration.rb
 - lib/twitter_tweet_bot/entity.rb
 - lib/twitter_tweet_bot/entity/authorization.rb
 - lib/twitter_tweet_bot/entity/base.rb