simple_tweet 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb994313a55f3a80782b1c73c983a7551fa2a394f49aa5149efdf59372d20d40
-  data.tar.gz: 2dff9773d979e4f907b1ad37072adc59d30d13c64d73ed26a004032a50cc2456
+  metadata.gz: eda2472eda06f1ddc2348a30e194c498e0cd9998036e7dabdbdee4850e1098dc
+  data.tar.gz: 50c944ffd64e0f687f968d254389bd2fab8b521b959c5433fbe2aecfe772507e
 SHA512:
-  metadata.gz: e5425884322fcb27da54bf4747c709ad412c9479daf0fd0b040209dbbec8be6f5d930505b4a72c85dabbef8a55b5817b5f5d83f7be2a8255d4e2aaa9253ec4e3
-  data.tar.gz: 31fb1439304050a6038b19ce25520795eb3588ebcdfe29b75b1249adbbdfff932f79833c131ef3492ff784599f2e4e3301222f7885784d60de2a634652d6cbef
+  metadata.gz: a24c2848c3164782c1e424ac6fa6504fb4c1df5b1d720e92323cea4c8298d9327d1878fc49e1b13091c1a043bd612efd06a409ad2bc218c82cb650b962222f3c
+  data.tar.gz: e03a4050dc75280addf7a86cad0faa1cc9541c39abbe2f9d1adca6a6fd4cb4898712ff68d7411b0c382de6d85bb6aab4c29f13ae305bd33fce31afd61662a108

data/.rubocop.yml

@@ -9,6 +9,9 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 
@@ -20,3 +23,7 @@ Metrics/MethodLength:
 
 Metrics/AbcSize:
   Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.56"
+gem "steep"
+gem "webmock"

data/Gemfile.lock

@@ -1,19 +1,40 @@
 PATH
   remote: .
   specs:
-    simple_tweet (3.0.0)
+    simple_tweet (3.1.0)
       multipart-post (>= 2.2.3)
       oauth (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    csv (3.2.7)
     diff-lcs (1.5.0)
+    ffi (1.15.5)
+    fileutils (1.7.1)
+    hashdiff (1.0.1)
     hashie (5.0.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    minitest (5.20.0)
     multipart-post (2.3.0)
     oauth (1.1.0)
       oauth-tty (~> 1.0, >= 1.0.1)
@@ -25,9 +46,14 @@ GEM
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    public_suffix (5.0.3)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.2.1)
     regexp_parser (2.8.1)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -58,20 +84,48 @@ GEM
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.2.2)
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
+    steep (1.5.3)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 3.1.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     version_gem (1.1.3)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.56)
   simple_tweet!
+  steep
+  webmock
 
 BUNDLED WITH
    2.3.24

data/Steepfile

@@ -0,0 +1,11 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+  library "net-http"
+
+  configure_code_diagnostics(D::Ruby.strict) do |config|
+    config[D::Ruby::UnknownConstant] = :information
+  end
+end

data/lib/simple_tweet/v2_client.rb

@@ -27,7 +27,7 @@ module SimpleTweet
 
       # https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/migrate
       def tweet(message:, media_ids: [])
-        json = { text: message }
+        json = { text: message } # : ::Hash[::Symbol, (::String|::Hash[::Symbol, ::Array[::String]])]
         json[:media] = { media_ids: media_ids } unless media_ids.empty?
         header = { "User-Agent": UA, "content-type": "application/json" }
         access_token.post(TW_TWEET_PATH, json.to_json, header)
@@ -55,7 +55,10 @@ module SimpleTweet
         @client.sign! req
 
         url = ::URI.parse(TW_UPLOAD_ORIGIN + TW_MEDIA_UPLOAD_PATH)
-        https = ::Net::HTTP.new(url.host, url.port)
+        https = ::Net::HTTP.new(
+          url.host, # : ::String
+          url.port
+        )
         https.use_ssl = true
 
         https.start do |http|
@@ -63,6 +66,21 @@ module SimpleTweet
         end
       end
 
+      def request_with_retry(req:, expected_status_code:, error_kind_message:, retry_count: 3)
+        res = request(req)
+        return res if expected_status_code === res.code # rubocop:disable Style/CaseEquality
+        raise UploadMediaError.new(error_kind_message, response: res) unless retry_count.positive?
+
+        @client = nil # reset client
+        sleep 1 << (3 - retry_count)
+        request_with_retry(
+          req: req,
+          expected_status_code: expected_status_code,
+          error_kind_message: error_kind_message,
+          retry_count: retry_count - 1
+        )
+      end
+
       # https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload
       ## maybe todo: multiple image
       # ここはv1のAPIを叩いている。
@@ -85,55 +103,46 @@ module SimpleTweet
           total_bytes: video.size,
           media_type: "video/mp4"
         )
-        init_res = request(init_req)
-        raise UploadMediaError.new("init failed", response: init_res) unless init_res.code == "202"
-
+        init_res = request_with_retry(req: init_req, expected_status_code: "202", error_kind_message: "init failed")
         ::JSON.parse(init_res.body)
       end
 
-      def append(video:, media_id:, index:, retry_count: 0)
-        append_req = ::Net::HTTP::Post::Multipart.new(
+      def append(video:, media_id:, index:)
+        req = ::Net::HTTP::Post::Multipart.new(
           TW_MEDIA_UPLOAD_PATH,
           command: "APPEND",
           media_id: media_id,
           media: video.read(APPEND_PER),
           segment_index: index
         )
-        res = request(append_req)
-        return if res.code == "204"
-        raise UploadMediaError.new("append failed", response: res) unless retry_count <= @max_append_retry_
-
-        append(video: video, media_id: media_id, index: index, retry_count: retry_count + 1)
+        request_with_retry(req: req, expected_status_code: "204", error_kind_message: "append failed")
       end
 
       def finalize(media_id:)
-        finalize_req = ::Net::HTTP::Post::Multipart.new(
+        req = ::Net::HTTP::Post::Multipart.new(
           TW_MEDIA_UPLOAD_PATH,
           command: "FINALIZE",
           media_id: media_id
         )
-        finalize_res = request(finalize_req)
-        raise UploadMediaError.new("finalize failed", response: finalize_res) unless finalize_res.code == "201"
-
-        ::JSON.parse(finalize_res.body)
+        # finalizeは201が帰ってきてても、processing_infoにretry_afterが入っている場合がある(upload_video中で処理)。
+        res = request_with_retry(req: req, expected_status_code: /^20\d$/, error_kind_message: "finalize failed")
+        ::JSON.parse(res.body)
       end
 
       def status(media_id:)
-        status_req = ::Net::HTTP::Post::Multipart.new(
-          TW_MEDIA_UPLOAD_PATH,
-          command: "STATUS",
-          media_id: media_id
-        )
-        status_res = request(status_req)
-        raise UploadMediaError.new("status failed", response: status_res) unless status_res.code == "200"
-
-        ::JSON.parse(status_res.body)
+        # https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/get-media-upload-status
+        # これはGET
+        uri = ::URI.parse(TW_UPLOAD_ORIGIN + TW_MEDIA_UPLOAD_PATH)
+        uri.query = ::URI.encode_www_form(command: "STATUS", media_id: media_id)
+        req = ::Net::HTTP::Get.new(uri)
+        res = request_with_retry(req: req, expected_status_code: "200", error_kind_message: "status failed")
+        ::JSON.parse(res.body)
       end
 
       # https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init
       def upload_video(video:)
         init_res = init(video: video)
-        media_id = init_res["media_id_string"]
+        media_id = init_res["media_id_string"] # : String
 
         chunks_needed = (video.size - 1) / APPEND_PER + 1
         chunks_needed.times do |i|
@@ -165,13 +174,10 @@ module SimpleTweet
       end
 
       def create_media_metadata(media_id:, alt_text:)
-        header = { "content-type": "application/json; charset=UTF-8" }
+        header = { "content-type" => "application/json; charset=UTF-8" } # : ::Hash[::String, ::String]
         req = ::Net::HTTP::Post.new(TW_METADATA_CREATE_PATH, header)
         req.body = { media_id: media_id, alt_text: { text: alt_text } }.to_json
-        res = request(req)
-        raise UploadMediaError.new("create_media_metadata failed", response: res) if res.code != "200"
-
-        res
+        request_with_retry(req: req, expected_status_code: "200", error_kind_message: "create_media_metadata failed")
       end
     end
   end

data/lib/simple_tweet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleTweet
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/simple_tweet.rb

@@ -11,7 +11,7 @@ module SimpleTweet
     attr_reader :response
 
     def initialize(message = nil, response: nil)
-      super(message)
+      super(message) unless message.nil?
       @response = response
     end
   end

data/rbs_collection.lock.yaml

@@ -0,0 +1,50 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 248499a924c3cb331d40ca667d40528814043788
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 248499a924c3cb331d40ca667d40528814043788
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: '0'
+  source:
+    type: stdlib
+- name: hashie
+  version: '5.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 248499a924c3cb331d40ca667d40528814043788
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 248499a924c3cb331d40ca667d40528814043788
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 248499a924c3cb331d40ca667d40528814043788
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,17 @@
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# 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: steep
+    ignore: true

data/sig/simple_tweet.rbs

@@ -1,4 +1,46 @@
 module SimpleTweet
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  module V2
+    class Client
+      TW_API_ORIGIN: String
+      TW_UPLOAD_ORIGIN: String
+      TW_MEDIA_UPLOAD_PATH: String
+      TW_METADATA_CREATE_PATH: String
+      TW_TWEET_PATH: String
+      UA: String
+      APPEND_PER: Integer
+
+      def initialize: (consumer_key: String, consumer_secret: String, access_token: String, access_token_secret: String, ?max_append_retry: Integer) -> void
+      def tweet: (message: String, ?media_ids: Array[String]) -> Net::HTTPResponse
+      def tweet_with_media: (message: String, media_type: String, media: untyped, ?alt_text: String?) -> Net::HTTPResponse
+
+      @consumer_key_: String
+      @consumer_secret_: String
+      @access_token_: String
+      @access_token_secret_: String
+      @max_append_retry_: Integer
+      @client: untyped # ::OAuth::AccessToken
+
+      private
+      def access_token: (?site: String) -> untyped
+      def request: (Net::HTTPRequest req) -> Net::HTTPResponse
+      def request_with_retry: (req: Net::HTTPRequest, expected_status_code: String | Regexp, error_kind_message: String, ?retry_count: Integer) -> Net::HTTPResponse
+      def upload_media: (media_type: String, media: untyped) -> [String]
+      def init: (video: untyped) -> Hash[String, untyped]
+      def append: (video: untyped, media_id: String, index: untyped) -> Net::HTTPResponse
+      def finalize: (media_id: String) -> Hash[String, untyped]
+      def status: (media_id: String) -> Hash[String, untyped]
+      def upload_video: (video: untyped) -> [String]
+      def create_media_metadata: (media_id: String, alt_text: String?) -> Net::HTTPResponse
+    end
+  end
+
+  class Error < StandardError
+  end
+
+  class UploadMediaError < Error
+    attr_reader response: Net::HTTPResponse?
+    def initialize: (?String? message, ?response: Net::HTTPResponse?) -> void
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_tweet
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Kugayama Nana
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -53,9 +53,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - lib/simple_tweet.rb
 - lib/simple_tweet/v2_client.rb
 - lib/simple_tweet/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sig/simple_tweet.rbs
 - simple_tweet.gemspec
 homepage: https://github.com/nota/simple_tweet