simple_twitter 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9efa656f4b989f1702d73b9fc4dcd1526edeb944fd9de450993cea3a359ac980
-  data.tar.gz: eb2027e3aaf434de6014f8ad60775af313c6a3bc88dfca3ac350dd5ad4798c91
+  metadata.gz: 07a8547bff9c7cd57a04a9286f0356d0254144fcaee53fbba5209be5a2f9b1ef
+  data.tar.gz: bfcd987e1efab7ea72c86050d661b1e702fd2be902dc2c7d691f2f4b5e601f3e
 SHA512:
-  metadata.gz: d7f681333e86714dbf3aba86319761118c002b914f0d45579b9c35bcb0d0937a4a276ee04137c7cc76cdf66ddd25ab057e431420bd3b95b0fa91e411a96925d0
-  data.tar.gz: 7c0159dbc2da88fed921c25887488b5c81406ebcb4793ff10bf76de8d447cb5d8d61f7954c0c44a0b766e3ee1828d68f6ef9c9fa2812eaf709ab5f705d678579
+  metadata.gz: 839a64b8effe471567cb3eedcf83e7d48d06c365bb7fb68fa361f59205111ffd3d04b56ff895b76f8a2865426673f5e1b24cf36a09d5d5c59c30e9f6d0a3aafb
+  data.tar.gz: e01225940b9728ab6decb8710eee1694693e7e76a77bc912112a3f92fc1fb548034eb31d22c810883343d862992f5cf4bb088002ff2a9ee94a73699ccfeeb43b

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

@@ -8,3 +8,4 @@
 /tmp/
 Gemfile.lock
 .env
+.gem_rbs_collection/

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Unreleased
-https://github.com/yhara/simple_twitter/compare/v2.1.0...main
+https://github.com/yhara/simple_twitter/compare/v2.2.1...main
+
+## v2.2.1 (2023-07-25)
+https://github.com/yhara/simple_twitter/compare/v2.2.0...v2.2.1
+
+* Fix rbs for Nillable args
+  * https://github.com/yhara/simple_twitter/pull/30
+
+## 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

data/README.md

@@ -111,11 +111,12 @@ media = client.post(
 #  :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]] },
-            }
+client.post(
+  "https://api.twitter.com/2/tweets",
+  json: { 
+    text: "Test tweet with image", 
+    media: { media_ids: [media[:media_id_string]] },
+  }
 )
 ```
 

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/lib/simple_twitter/client.rb

@@ -40,6 +40,7 @@ module SimpleTwitter
     #   @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]
+    #   @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
 
     # @!method post(url, params: {}, json: {}, form: {})
     #   Call Twitter API with POST method
@@ -58,6 +59,7 @@ module SimpleTwitter
     #   @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]
+    #   @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
 
     # @!method put(url, params: {}, json: {}, form: {})
     #   Call Twitter API with PUT method
@@ -76,6 +78,7 @@ module SimpleTwitter
     #   @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]
+    #   @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
 
     # @!method delete(url, params: {}, json: {}, form: {})
     #   Call Twitter API with DELETE method
@@ -94,6 +97,7 @@ module SimpleTwitter
     #   @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]
+    #   @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
 
     %i[get post put delete].each do |m|
       class_eval <<~EOD
@@ -151,6 +155,7 @@ module SimpleTwitter
     # @return [Hash] parsed json data
     # @raise [SimpleTwitter::ClientError] Twitter API returned 4xx error
     # @raise [SimpleTwitter::ServerError] Twitter API returned 5xx error
+    # @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
     def parse_response(res)
       case res.code.to_i / 100
       when 4

data/lib/simple_twitter/error.rb

@@ -3,13 +3,16 @@ module SimpleTwitter
   class Error < StandardError
     # @!attribute [r] raw_response
     # @return [HTTP::Response] raw error response
+    # @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
     attr_reader :raw_response
 
     # @!attribute [r] body
     # @return [Hash<Symbol, String>] error response body
+    # @see https://developer.twitter.com/en/support/twitter-api/error-troubleshooting error response body format
     attr_reader :body
 
     # @param raw_response [HTTP::Response] raw error response from Twitter API
+    # @see https://www.rubydoc.info/github/httprb/http/HTTP/Response HTTP::Response documentation
     def initialize(raw_response)
       @raw_response = raw_response
 

data/lib/simple_twitter/version.rb

@@ -1,3 +1,3 @@
 module SimpleTwitter
-  VERSION = "2.1.0"
+  VERSION = "2.2.1"
 end

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

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   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.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Yutaka HARA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -81,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
@@ -129,6 +143,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - lib/simple_twitter.rb
@@ -137,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: