simple_tweet 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e8b7b5eef07f8a7108285eeb67aa7708fd0f810b49c497e4d2a2e7e988f671d
-  data.tar.gz: f0501a28e4072c89f67944a7982394fd21ebd3fbc0e852dd18b5d3eb98fc0d97
+  metadata.gz: cb994313a55f3a80782b1c73c983a7551fa2a394f49aa5149efdf59372d20d40
+  data.tar.gz: 2dff9773d979e4f907b1ad37072adc59d30d13c64d73ed26a004032a50cc2456
 SHA512:
-  metadata.gz: 38863d94493b2b4a71f0306327d7db02785e2118d852b5dd5508e642e9bbc0d8d453104ab08853da9b2ded125d49e782afa99913fe16f09726c0da5acad77d53
-  data.tar.gz: 7e8e2ad9278bacef086651331964f40c1020257339e3599128903081cc5123ec40904597c6568a51bd10c7a10597ec16d52fab2a3bdc5c58aeadc97726ec7d48
+  metadata.gz: e5425884322fcb27da54bf4747c709ad412c9479daf0fd0b040209dbbec8be6f5d930505b4a72c85dabbef8a55b5817b5f5d83f7be2a8255d4e2aaa9253ec4e3
+  data.tar.gz: 31fb1439304050a6038b19ce25520795eb3588ebcdfe29b75b1249adbbdfff932f79833c131ef3492ff784599f2e4e3301222f7885784d60de2a634652d6cbef

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true
@@ -13,7 +13,7 @@ Layout/LineLength:
   Max: 120
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 150
 
 Metrics/MethodLength:
   Max: 30

data/Gemfile

@@ -6,7 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.56"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    simple_tweet (3.0.0)
+      multipart-post (>= 2.2.3)
+      oauth (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    hashie (5.0.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    multipart-post (2.3.0)
+    oauth (1.1.0)
+      oauth-tty (~> 1.0, >= 1.0.1)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    oauth-tty (1.0.5)
+      version_gem (~> 1.1, >= 1.1.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    unicode-display_width (2.4.2)
+    version_gem (1.1.3)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.56)
+  simple_tweet!
+
+BUNDLED WITH
+   2.3.24

data/lib/simple_tweet/v2_client.rb

@@ -1,18 +1,178 @@
+# frozen_string_literal: true
+
 require "json"
+require "cgi"
+require "oauth"
+require "net/http/post/multipart"
 
 module SimpleTweet
   module V2
-    # mediaのuploadはapi 1.1しか用意されていないため、それを使う。
-    class Client < V1::Client
+    # Twitte API v2を叩くクライアント
+    class Client
+      TW_API_ORIGIN = "https://api.twitter.com"
+      TW_UPLOAD_ORIGIN = "https://upload.twitter.com"
+      TW_MEDIA_UPLOAD_PATH = "/1.1/media/upload.json"
+      TW_METADATA_CREATE_PATH = "/1.1/media/metadata/create.json"
       TW_TWEET_PATH = "/2/tweets"
-      UA = "SimpleTweet/#{SimpleTweet::VERSION}"
+      UA = "SimpleTweet/#{SimpleTweet::VERSION}".freeze
+      APPEND_PER = 5 * (1 << 20)
+
+      def initialize(consumer_key:, consumer_secret:, access_token:, access_token_secret:, max_append_retry: 3)
+        @consumer_key_ = consumer_key
+        @consumer_secret_ = consumer_secret
+        @access_token_ = access_token
+        @access_token_secret_ = access_token_secret
+        @max_append_retry_ = max_append_retry
+      end
 
+      # https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/migrate
       def tweet(message:, media_ids: [])
         json = { text: message }
         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)
       end
+
+      def tweet_with_media(message:, media_type:, media:, alt_text: nil)
+        media_ids = upload_media(media_type: media_type, media: media)
+        unless alt_text.nil?
+          media_ids.each do |media_id|
+            create_media_metadata(media_id: media_id, alt_text: alt_text)
+          end
+        end
+        tweet(message: message, media_ids: media_ids)
+      end
+
+      private
+
+      def access_token(site: TW_API_ORIGIN)
+        consumer = ::OAuth::Consumer.new(@consumer_key_, @consumer_secret_, site: site)
+        ::OAuth::AccessToken.new(consumer, @access_token_, @access_token_secret_)
+      end
+
+      def request(req)
+        @client ||= access_token(site: TW_UPLOAD_ORIGIN)
+        @client.sign! req
+
+        url = ::URI.parse(TW_UPLOAD_ORIGIN + TW_MEDIA_UPLOAD_PATH)
+        https = ::Net::HTTP.new(url.host, url.port)
+        https.use_ssl = true
+
+        https.start do |http|
+          http.request req
+        end
+      end
+
+      # https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload
+      ## maybe todo: multiple image
+      # ここはv1のAPIを叩いている。
+      def upload_media(media_type:, media:)
+        return upload_video(video: media) if media_type == "video/mp4"
+
+        req = ::Net::HTTP::Post::Multipart.new(
+          TW_MEDIA_UPLOAD_PATH,
+          media: ::UploadIO.new(media, media_type),
+          media_category: "tweet_image"
+        )
+        res = ::JSON.parse(request(req).body)
+        [res["media_id_string"]]
+      end
+
+      def init(video:)
+        init_req = ::Net::HTTP::Post::Multipart.new(
+          TW_MEDIA_UPLOAD_PATH,
+          command: "INIT",
+          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"
+
+        ::JSON.parse(init_res.body)
+      end
+
+      def append(video:, media_id:, index:, retry_count: 0)
+        append_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)
+      end
+
+      def finalize(media_id:)
+        finalize_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)
+      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)
+      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"]
+
+        chunks_needed = (video.size - 1) / APPEND_PER + 1
+        chunks_needed.times do |i|
+          append(video: video, media_id: media_id, index: i)
+        end
+
+        finalize_res = finalize(media_id: media_id)
+
+        if finalize_res["processing_info"]
+          retry_after = finalize_res["processing_info"]["check_after_secs"] || 5
+          loop do
+            sleep retry_after
+
+            status_res = status(media_id: media_id)
+            raise UploadMediaError if status_res["processing_info"].nil?
+            break if status_res["processing_info"]["state"] == "succeeded"
+
+            if status_res["processing_info"]["state"] == "in_progress"
+              retry_after = status_res["processing_info"]["check_after_secs"] || 5
+              next
+            end
+
+            # status_res_json["processing_info"]["state"] == "failed"
+            raise UploadMediaError
+          end
+        end
+
+        [media_id]
+      end
+
+      def create_media_metadata(media_id:, alt_text:)
+        header = { "content-type": "application/json; charset=UTF-8" }
+        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
+      end
     end
   end
 end

data/lib/simple_tweet/version.rb

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

data/lib/simple_tweet.rb

@@ -1,132 +1,18 @@
 # frozen_string_literal: true
 
 require_relative "simple_tweet/version"
-require_relative "simple_tweet/v1_client"
 require_relative "simple_tweet/v2_client"
-require "json"
 
 module SimpleTweet
   class Error < ::StandardError; end
-  class UploadMediaError < Error; end
 
-  # Twitter::Tweetに近いinterfaceを提供する。
-  ## 使ってない部分のhashの中身のhashとかは正規化されてないので、必要になったら足す必要がある。
-  ### todo: entities, media, ...
-  ## 逆に、本体とuserのところだけHashから変換している。
-  Tweet = ::Struct.new(
-    :created_at,
-    :id,
-    :id_str,
-    :text,
-    :truncated,
-    :entities,
-    :source,
-    :in_reply_to_status_id,
-    :in_reply_to_status_id_str,
-    :in_reply_to_user_id,
-    :in_reply_to_user_id_str,
-    :in_reply_to_screen_name,
-    :user,
-    :geo,
-    :coordinates,
-    :place,
-    :contributors,
-    :is_quote_status,
-    :retweet_count,
-    :favorite_count,
-    :favorited,
-    :retweeted,
-    :lang,
-    :extended_entities,
-    :possibly_sensitive,
-    :quoted_status_id,
-    :quoted_status_id_str,
-    :quoted_status,
-    keyword_init: true
-  )
-  User = ::Struct.new(
-    :id,
-    :id_str,
-    :name,
-    :screen_name,
-    :location,
-    :description,
-    :url,
-    :entities,
-    :protected,
-    :followers_count,
-    :friends_count,
-    :listed_count,
-    :created_at,
-    :favourites_count,
-    :utc_offset,
-    :time_zone,
-    :geo_enabled,
-    :verified,
-    :statuses_count,
-    :lang,
-    :contributors_enabled,
-    :is_translator,
-    :is_translation_enabled,
-    :profile_background_color,
-    :profile_background_image_url,
-    :profile_background_image_url_https,
-    :profile_background_tile,
-    :profile_image_url,
-    :profile_image_url_https,
-    :profile_banner_url,
-    :profile_link_color,
-    :profile_sidebar_border_color,
-    :profile_sidebar_fill_color,
-    :profile_text_color,
-    :profile_use_background_image,
-    :has_extended_profile,
-    :default_profile,
-    :default_profile_image,
-    :following,
-    :follow_request_sent,
-    :notifications,
-    :translator_type,
-    :withheld_in_countries,
-    keyword_init: true
-  )
+  # UploadMediaError is
+  class UploadMediaError < Error
+    attr_reader :response
 
-  # Tweet is like Twitter::Tweet
-  class Tweet
-    def self.from_response(response)
-      return nil unless response.code == "200"
-
-      res = ::JSON.parse(response.body)
-      tw = Tweet.new(**res)
-      tw.created_at = ::Time.parse(tw.created_at).utc
-      tw.user = User.new(**res["user"])
-      tw
-    end
-
-    def uri
-      "https://twitter.com/#{user.screen_name}/status/#{id}"
-    end
-    alias url uri
-
-    def to_h
-      super.map do |k, v|
-        if k == :user
-          [k.to_s, v.to_h]
-        else
-          [k.to_s, v]
-        end
-      end.to_h
-    end
-  end
-
-  # User is
-  class User
-    def protected?
-      protected
-    end
-
-    def to_h
-      super.transform_keys(&:to_s)
+    def initialize(message = nil, response: nil)
+      super(message)
+      @response = response
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_tweet
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kugayama Nana
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -49,11 +49,11 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/simple_tweet.rb
-- lib/simple_tweet/v1_client.rb
 - lib/simple_tweet/v2_client.rb
 - lib/simple_tweet/version.rb
 - sig/simple_tweet.rbs

data/lib/simple_tweet/v1_client.rb

@@ -1,156 +0,0 @@
-require "cgi"
-require "oauth"
-require "json"
-require "net/http/post/multipart"
-
-module SimpleTweet
-  module V1
-    # Client provides only tweet
-    class Client
-      TW_API_ORIGIN = "https://api.twitter.com"
-      TW_UPLOAD_ORIGIN = "https://upload.twitter.com"
-      TW_MEDIA_UPLOAD_PATH = "/1.1/media/upload.json"
-      APPEND_PER = 5 * (1 << 20)
-
-      def initialize(consumer_key:, consumer_secret:, access_token:, access_token_secret:, max_append_retry: 3)
-        @consumer_key_ = consumer_key
-        @consumer_secret_ = consumer_secret
-        @access_token_ = access_token
-        @access_token_secret_ = access_token_secret
-        @max_append_retry_ = max_append_retry
-      end
-
-      # https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update
-      def tweet(message:, media_ids: [])
-        path = "/1.1/statuses/update.json?status=#{::CGI.escape(message)}"
-        path += "&media_ids=#{media_ids.join(",")}" unless media_ids.empty?
-        Tweet.from_response(access_token.post(path))
-      end
-
-      # media_type is mime_type
-      def tweet_with_media(message:, media_type:, media:)
-        media_ids = upload_media(media_type: media_type, media: media)
-        tweet(message: message, media_ids: media_ids)
-      end
-
-      private
-
-      def access_token(site: TW_API_ORIGIN)
-        consumer = ::OAuth::Consumer.new(@consumer_key_, @consumer_secret_, site: site)
-        ::OAuth::AccessToken.new(consumer, @access_token_, @access_token_secret_)
-      end
-
-      def request(req)
-        @client ||= access_token(site: TW_UPLOAD_ORIGIN)
-        @client.sign! req
-
-        url = ::URI.parse(TW_UPLOAD_ORIGIN + TW_MEDIA_UPLOAD_PATH)
-        https = ::Net::HTTP.new(url.host, url.port)
-        https.use_ssl = true
-
-        https.start do |http|
-          http.request req
-        end
-      end
-
-      # https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload
-      ## maybe todo: multiple image
-      def upload_media(media_type:, media:)
-        return upload_video(video: media) if media_type == "video/mp4"
-
-        req = ::Net::HTTP::Post::Multipart.new(
-          TW_MEDIA_UPLOAD_PATH,
-          media: ::UploadIO.new(media, media_type),
-          media_category: "tweet_image"
-        )
-        res = ::JSON.parse(request(req).body)
-        [res["media_id_string"]]
-      end
-
-      def init(video:)
-        init_req = ::Net::HTTP::Post::Multipart.new(
-          TW_MEDIA_UPLOAD_PATH,
-          command: "INIT",
-          total_bytes: video.size,
-          media_type: "video/mp4"
-        )
-        init_res = request(init_req)
-        raise UploadMediaError unless init_res.code == "202"
-
-        ::JSON.parse(init_res.body)
-      end
-
-      def append(video:, media_id:, index:, retry_count: 0)
-        append_req = ::Net::HTTP::Post::Multipart.new(
-          TW_MEDIA_UPLOAD_PATH,
-          command: "APPEND",
-          media_id: media_id,
-          media: video.read(APPEND_PER),
-          segment_index: index
-        )
-        return if request(append_req).code == "204"
-        raise UploadMediaError unless retry_count <= @max_append_retry_
-
-        append(video: video, media_id: media_id, index: index, retry_count: retry_count + 1)
-      end
-
-      def finalize(media_id:)
-        finalize_req = ::Net::HTTP::Post::Multipart.new(
-          TW_MEDIA_UPLOAD_PATH,
-          command: "FINALIZE",
-          media_id: media_id
-        )
-        finalize_res = request(finalize_req)
-        raise UploadMediaError unless finalize_res.code == "201"
-
-        ::JSON.parse(finalize_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 unless status_res.code == "200"
-
-        ::JSON.parse(status_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"]
-
-        chunks_needed = (video.size - 1) / APPEND_PER + 1
-        chunks_needed.times do |i|
-          append(video: video, media_id: media_id, index: i)
-        end
-
-        finalize_res = finalize(media_id: media_id)
-
-        if finalize_res["processing_info"]
-          retry_after = finalize_res["processing_info"]["check_after_secs"] || 5
-          loop do
-            sleep retry_after
-
-            status_res = status(media_id: media_id)
-            raise UploadMediaError if status_res["processing_info"].nil?
-            break if status_res["processing_info"]["state"] == "succeeded"
-
-            if status_res["processing_info"]["state"] == "in_progress"
-              retry_after = status_res["processing_info"]["check_after_secs"] || 5
-              next
-            end
-
-            # status_res_json["processing_info"]["state"] == "failed"
-            raise UploadMediaError
-          end
-        end
-
-        [media_id]
-      end
-    end
-  end
-end