simple_twitter 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6658a0b3e20a5da4a1a59d28ee5062bb2f1e816e6298cf49dcc48d0cfda2bcbb
-  data.tar.gz: 7295ee6a0d9ecd2ea5fe264bfcbe4357d8e2cde9b40db0001f0ebb39e7479399
+  metadata.gz: 671c43acc2022139dba5f4f69a76f518fdd46561c7081211a324e3ba1e2d75d5
+  data.tar.gz: 3f6b0607f128651fbfda09b6911d83a01f9f8bc03c04f714fcc7f67c65ad5c55
 SHA512:
-  metadata.gz: aa8c402510a617b96a6dd6c239c7d4d9b0c9e01fc7202f371ba826b095c01542ba2ee76ef11d953b7aa76e3c8099597cf3d0bd2da7fa264c98214c87ad8b1e96
-  data.tar.gz: 02eead6edb730eb7562dc7869ca15d8908b5424526a902afc68912f69a1aa847c32531d57291802237854dc84af3681a931474362e0704eec31740057c59f55d
+  metadata.gz: '029f55ae678e76b578b4fd350694439a253b4f3b9165a6926e709df1b5ac6d1b8bc908a299ab4e0bfb01a1c88a0ad2035c5a5259827323104c73d3816ea1a30e'
+  data.tar.gz: 2dcb7f62d814e81967ec466a2d746ed89a27c1191a416ceec7de0ffe1f0a4c33f664a0f2337250a76c83cc1cbd5a0371871b0e417f3a00f966ae95d6bcaecddd

data/.env.example

@@ -0,0 +1,5 @@
+# TWITTER_OAUTH2_BEARER_TOKEN=
+# TWITTER_OAUTH1_API_KEY=
+# TWITTER_OAUTH1_API_SECRET_KEY=
+# TWITTER_OAUTH1_ACCESS_TOKEN=
+# TWITTER_OAUTH1_ACCESS_TOKEN_SECRET=

data/.github/workflows/test.yml

@@ -46,3 +46,24 @@ jobs:
 
       - run: bundle exec rspec
       - run: bundle exec yard --fail-on-warning
+
+  rbs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+
+      - run: bundle exec rbs collection install
+      - run: bundle exec rbs validate --silent
+      - run: bundle exec steep check

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+.env
+.gem_rbs_collection/

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## Unreleased
-https://github.com/yhara/simple_twitter/compare/v2.0.0...main
+https://github.com/yhara/simple_twitter/compare/v2.2.0...main
+
+## v2.2.0 (2023-07-24)
+https://github.com/yhara/simple_twitter/compare/v2.1.0...v2.2.0
+
+* Add rbs
+  * https://github.com/yhara/simple_twitter/pull/21
+
+## v2.1.0 (2023-07-22)
+https://github.com/yhara/simple_twitter/compare/v2.0.0...v2.1.0
+
+* Support media uploading
+  * https://github.com/yhara/simple_twitter/pull/26
+* Add User-Agent
+  * https://github.com/yhara/simple_twitter/pull/27
 
 ## v2.0.0 (2023-07-17)
 https://github.com/yhara/simple_twitter/compare/v1.0.0...v2.0.0

data/README.md

@@ -77,6 +77,49 @@ client = SimpleTwitter::Client.new(bearer_token: ENV["ACCESS_TOKEN"])
 client.post("https://api.twitter.com/2/tweets", json: { text: "Hello twitter!" })
 ```
 
+### Upload media
+If you want to tweet with an image, you need to do the following steps
+
+1. Upload image as media
+    * c.f. https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload
+2. Tweet with media
+    * c.f. https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets
+
+e.g.
+
+```ruby
+config = (load from yaml or something)
+client = SimpleTwitter::Client.new(
+  api_key: config[:api_key],
+  api_secret_key: config[:api_secret_key],
+  access_token: config[:access_token],
+  access_token_secret: config[:access_token_secret],
+)
+
+# Upload image as media
+media = client.post(
+          "https://upload.twitter.com/1.1/media/upload.json",
+          form: {
+            media: HTTP::FormData::File.new("/path/to/image.png")
+          }
+        )
+# =>
+# {:media_id=>12345678901234567890,
+#  :media_id_string=>"12345678901234567890",
+#  :size=>60628,
+#  :expires_after_secs=>86400,
+#  :image=>{:image_type=>"image/png", :w=>400, :h=>400}}
+
+# Tweet with media
+client.post(
+  "https://api.twitter.com/2/tweets",
+  json: { 
+    text: "Test tweet with image", 
+    media: { media_ids: [media[:media_id_string]] },
+  }
+)
+```
+
 ### Advanced
 
 If you want the raw json string or use streaming API, use `get_raw`, `post_raw`, etc. which returns `HTTP::Response` of the [http gem](https://github.com/httprb/http).

data/Steepfile

@@ -0,0 +1,30 @@
+# D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+  # check "Gemfile"                   # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+  library "json"
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname"              # Standard libraries
+# end

data/bin/console

@@ -3,6 +3,7 @@
 
 require "bundler/setup"
 require "simple_twitter"
+require "dotenv/load"
 
 # 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.
@@ -11,5 +12,13 @@ require "simple_twitter"
 # require "pry"
 # Pry.start
 
+@client = SimpleTwitter::Client.new(
+  bearer_token:        ENV["TWITTER_OAUTH2_BEARER_TOKEN"],
+  api_key:             ENV["TWITTER_OAUTH1_API_KEY"],
+  api_secret_key:      ENV["TWITTER_OAUTH1_API_SECRET_KEY"],
+  access_token:        ENV["TWITTER_OAUTH1_ACCESS_TOKEN"],
+  access_token_secret: ENV["TWITTER_OAUTH1_ACCESS_TOKEN_SECRET"],
+)
+
 require "irb"
 IRB.start(__FILE__)

data/lib/simple_twitter/client.rb

@@ -1,11 +1,11 @@
 module SimpleTwitter
   # Twitter API Client
   class Client
-    # @param bearer_token [String] This requires for API v2
-    # @param api_key [String] This requires for API v1.1
-    # @param api_secret_key [String] This requires for API v1.1
-    # @param access_token [String] This requires for API v1.1
-    # @param access_token_secret [String] This requires for API v1.1
+    # @param bearer_token [String] This requires for OAuth 2
+    # @param api_key [String] This requires for OAuth 1.0a
+    # @param api_secret_key [String] This requires for OAuth 1.0a
+    # @param access_token [String] This requires for OAuth 1.0a
+    # @param access_token_secret [String] This requires for OAuth 1.0a
     def initialize(bearer_token: nil,
                    api_key: nil,
                    api_secret_key: nil,
@@ -23,80 +23,87 @@ module SimpleTwitter
       end
     end
 
-    # @!method get(url, params: {}, json: {})
+    # @!method get(url, params: {}, json: {}, form: {})
     #   Call Twitter API with GET method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [Hash] parsed json data
     #   @raise [SimpleTwitter::ClientError] Twitter API returned 4xx error
     #   @raise [SimpleTwitter::ServerError] Twitter API returned 5xx error
 
-    # @!method get_raw(url, params: {}, json: {})
+    # @!method get_raw(url, params: {}, json: {}, form: {})
     #   Call Twitter API with GET method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [HTTP::Response]
 
-    # @!method post(url, params: {}, json: {})
+    # @!method post(url, params: {}, json: {}, form: {})
     #   Call Twitter API with POST method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [Hash] parsed json data
     #   @raise [SimpleTwitter::ClientError] Twitter API returned 4xx error
     #   @raise [SimpleTwitter::ServerError] Twitter API returned 5xx error
 
-    # @!method post_raw(url, params: {}, json: {})
+    # @!method post_raw(url, params: {}, json: {}, form: {})
     #   Call Twitter API with POST method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [HTTP::Response]
 
-    # @!method put(url, params: {}, json: {})
+    # @!method put(url, params: {}, json: {}, form: {})
     #   Call Twitter API with PUT method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [Hash] parsed json data
     #   @raise [SimpleTwitter::ClientError] Twitter API returned 4xx error
     #   @raise [SimpleTwitter::ServerError] Twitter API returned 5xx error
 
-    # @!method put_raw(url, params: {}, json: {})
+    # @!method put_raw(url, params: {}, json: {}, form: {})
     #   Call Twitter API with PUT method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [HTTP::Response]
 
-    # @!method delete(url, params: {}, json: {})
+    # @!method delete(url, params: {}, json: {}, form: {})
     #   Call Twitter API with DELETE method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [Hash] parsed json data
     #   @raise [SimpleTwitter::ClientError] Twitter API returned 4xx error
     #   @raise [SimpleTwitter::ServerError] Twitter API returned 5xx error
 
-    # @!method delete_raw(url, params: {}, json: {})
+    # @!method delete_raw(url, params: {}, json: {}, form: {})
     #   Call Twitter API with DELETE method
     #   @param url [String]
     #   @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
     #   @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    #   @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
     #   @return [HTTP::Response]
 
     %i[get post put delete].each do |m|
       class_eval <<~EOD
-        def #{m}(url, params: {}, json: {})
-          res = #{m}_raw(url, params: params, json: json)
+        def #{m}(url, params: {}, json: {}, form: {})
+          res = #{m}_raw(url, params: params, json: json, form: form)
           parse_response(res)
         end
 
-        def #{m}_raw(url, params: {}, json: {})
-          args = { params: params }
-          args[:json] = json unless json.empty?
+        def #{m}_raw(url, params: {}, json: {}, form: {})
+          args = create_http_args(params: params, json: json, form: form)
           http(:#{m}, url, params).#{m}(url, args)
         end
       EOD
@@ -104,6 +111,22 @@ module SimpleTwitter
 
     private
 
+    # @param params [Hash] Send this arg as a query string. (e.g. `?name1=value1&name2=value2`)
+    # @param json [Hash] Send this arg as JSON request body with `Content-Type: application/json` header
+    # @param form [Hash] Send this arg as form-data request body with `Content-Type: multipart/form-data` header
+    # @return [Hash<Symbol, Object>]
+    def create_http_args(params:, json:, form:)
+      args = {
+        params: params,
+        headers: {
+          "User-Agent" => "simple_twitter v#{SimpleTwitter::VERSION} (https://github.com/yhara/simple_twitter)",
+        },
+      }
+      args[:json] = json unless json.empty?
+      args[:form] = form unless form.empty?
+      args
+    end
+
     # @param method [Symbol]
     # @param url [String]
     # @param params [Hash<Symbol, String>]

data/lib/simple_twitter/version.rb

@@ -1,3 +1,3 @@
 module SimpleTwitter
-  VERSION = "2.0.0"
+  VERSION = "2.2.0"
 end

data/lib/simple_twitter.rb

@@ -1,6 +1,8 @@
 require 'http'
 require 'simple_oauth'
 
+require_relative "simple_twitter/version"
+
 module SimpleTwitter
   autoload :Client,      "simple_twitter/client"
   autoload :ClientError, "simple_twitter/client_error"

data/rbs_collection.lock.yaml

@@ -0,0 +1,26 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: aeede7258d020bfd509541e0c8075ce833292409
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: http
+  version: '5.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: aeede7258d020bfd509541e0c8075ce833292409
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: simple_oauth
+  version: '0.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: aeede7258d020bfd509541e0c8075ce833292409
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,30 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true
+
+  - name: simple_twitter
+    ignore: true
+  - name: steep
+    ignore: true
+  - name: yard
+    ignore: true
+
+  - name: http
+  - name: simple_oauth

data/sig/simple_twitter/client.rbs

@@ -0,0 +1,28 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+  class Client
+    @bearer_token: string
+    @oauth_params: {consumer_key: string, consumer_secret: string, token: string, token_secret: string}
+
+    def initialize: (?bearer_token: string, ?api_key: string, ?api_secret_key: string, ?access_token: string, ?access_token_secret: string) -> void
+
+    def get:    (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+    def post:   (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+    def put:    (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+    def delete: (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+
+    def get_raw:    (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> HTTP::Response
+    def post_raw:   (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> HTTP::Response
+    def put_raw:    (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> HTTP::Response
+    def delete_raw: (String url, params: Hash[Symbol, untyped], json: Hash[Symbol, untyped]) -> HTTP::Response
+
+    private
+
+    def create_http_args: (params: Hash[Symbol, untyped], json: Hash[Symbol, untyped], form: Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
+    def http: (Symbol method, String url, Hash[Symbol, String] params) -> HTTP::Client
+    def auth_header: (Symbol method, String url, Hash[Symbol, String] params) -> String
+    def parse_response: (HTTP::Response res) -> Hash[Symbol, untyped]
+  end
+end

data/sig/simple_twitter/client_error.rbs

@@ -0,0 +1,7 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+  class ClientError < Error
+  end
+end

data/sig/simple_twitter/error.rbs

@@ -0,0 +1,10 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+  class Error < StandardError
+    attr_reader raw_response: HTTP::Response
+    attr_reader body: Hash[Symbol, untyped]
+    def initialize: (HTTP::Response raw_response) -> void
+  end
+end

data/sig/simple_twitter/server_error.rbs

@@ -0,0 +1,7 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+  class ServerError < Error
+  end
+end

data/sig/simple_twitter/version.rbs

@@ -0,0 +1,6 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+  VERSION: String
+end

data/sig/simple_twitter.rbs

@@ -0,0 +1,5 @@
+# TypeProf 0.21.3
+
+# Classes
+module SimpleTwitter
+end

data/simple_twitter.gemspec

@@ -30,8 +30,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "http", ">= 4"
   spec.add_dependency "simple_oauth", ">= 0.3.1"
 
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "steep"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_twitter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Yutaka HARA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  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
@@ -103,6 +131,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".github/dependabot.yml"
 - ".github/workflows/pages.yml"
 - ".github/workflows/test.yml"
@@ -114,6 +143,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - lib/simple_twitter.rb
@@ -122,6 +152,14 @@ files:
 - lib/simple_twitter/error.rb
 - lib/simple_twitter/server_error.rb
 - lib/simple_twitter/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/simple_twitter.rbs
+- sig/simple_twitter/client.rbs
+- sig/simple_twitter/client_error.rbs
+- sig/simple_twitter/error.rbs
+- sig/simple_twitter/server_error.rbs
+- sig/simple_twitter/version.rbs
 - simple_twitter.gemspec
 homepage: https://github.com/yhara/simple_twitter
 licenses: