x 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab2b0ef63fad89db285efc1527b16a3b199691a5cb51013cc55f32fd1fcde56
-  data.tar.gz: e035f65fea8a8409a69a58f08ade709c2affe7c0afc12f62e6928d095ac2aa7f
+  metadata.gz: b4e43c461d1aa0e058f2dfcbb53f85fbcf5ade26e1f4a169a044454d9110f2b9
+  data.tar.gz: 267f92093e37ecc6e82c1fdd6cc2eb8615a58e6e586e4eaa63a4d8b890e1afc6
 SHA512:
-  metadata.gz: 41f24b7dc58d4d886da758a0d2b1430c68617c2594975c1fd17c9a04c7cde8a826e6672dd03c4be3ae3ba0d0022cfe8d0f6c6b5a97e2df64511a92e56e2c6361
-  data.tar.gz: ffc98321391ec7b71bed31dc82832086c39a79a76b18d0f0ae284a062d329f49fb96cd66421c8bae3b204a48978cc97a079be54b05883f6e462c2be2827f3a94
+  metadata.gz: 6c68483c77e776f13a7178775148ca16046515dad0ce3d259667b49d0194b89714d70fe0bddf9b14b0cd80514e276ad545fbf4913e9b65a8f106ec1e08443fa7
+  data.tar.gz: 58490badac233a7233331051fc7f2940e6648cd2c5a7de74261b968656b5617d01eeeea3eddfd514a25bac77628b54d78e09085924993700b8a52dc5817fd248

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.7.0] - 2023-09-02
+
+- Remove OAuth gem (7c29bb1)
+
 ## [0.6.0] - 2023-08-30
 
 - Add configurable debug output stream for logging (fd2d4b0)

data/README.md

@@ -1,31 +1,33 @@
 # X
 
-A Ruby interface to the X API.
+#### A Ruby interface to the X API.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add to the application's Gemfile:
 
-    $ bundle add x
+    bundle add x
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or, if Bundler is not being used to manage dependencies:
 
-    $ gem install x
+    gem install x
 
 ## Usage
 
+First, obtain X credentails from https://developer.x.com.
+
 ```ruby
-x_oauth_credentials = {
+x_credentials = {
   api_key:             "INSERT YOUR X API KEY HERE",
   api_key_secret:      "INSERT YOUR X API KEY SECRET HERE",
   access_token:        "INSERT YOUR X ACCESS TOKEN HERE",
   access_token_secret: "INSERT YOUR X ACCESS TOKEN SECRET HERE",
 }
 
-# Initialize X API client with OAuth credentials
-x_client = X::Client.new(**x_oauth_credentials)
+# Initialize an X API client with your OAuth credentials
+x_client = X::Client.new(**x_credentials)
 
-# Request yourself
+# Get data about yourself
 x_client.get("users/me")
 # {"data"=>{"id"=>"7505382", "name"=>"Erik Berlin", "username"=>"sferik"}}
 
@@ -33,18 +35,18 @@ x_client.get("users/me")
 tweet = x_client.post("tweets", '{"text":"Hello, World! (from @gem)"}')
 # {"data"=>{"edit_history_tweet_ids"=>["1234567890123456789"], "id"=>"1234567890123456789", "text"=>"Hello, World! (from @gem)"}}
 
-# Delete a tweet
+# Delete the tweet you just posted
 x_client.delete("tweets/#{tweet["data"]["id"]}")
 # {"data"=>{"deleted"=>true}}
 
 # Initialize an API v1.1 client
-v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_oauth_credentials)
+v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)
 
 # Request your account settings
 v1_client.get("account/settings.json")
 
 # Initialize an X Ads API client
-ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_oauth_credentials)
+ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_credentials)
 
 # Request your ad accounts
 ads_client.get("accounts")
@@ -52,29 +54,61 @@ ads_client.get("accounts")
 
 ## History and Philosophy
 
-This library is a rewrite of the [Twitter Ruby library](https://github.com/sferik/twitter). Over 16 years, that library ballooned to over 3,000 lines of code (plus 7,500 lines of tests). At the time of writing, this library is about 300 lines of code (plus 200 test lines) and I’d like to keep it that way. That doesn’t mean new features won’t be added over time, but the benefits of potential new features must be weighed against the benefits of simplicity:
+This library is a rewrite of the [Twitter Ruby library](https://github.com/sferik/twitter). Over 16 years of development, that library ballooned to over 3,000 lines of code (plus 7,500 lines of tests). At the time of writing, this library is about 300 lines of code (plus 200 test lines) and I’d like to keep it that way. That doesn’t mean new features won’t be added over time, but the benefits of more code must be weighted against the benefits of less:
 
 * Less code is easier to maintain.
 * Less code means fewer bugs.
 * Less code runs faster.
 
-In the immortal words of [Ezra Zygmuntowicz](https://github.com/ezmobius) and his [Merb](https://github.com/merb) project (may they both rest in peace): “No code is faster than no code.” The fastest code is the code that is never executed because it doesn’t exist. That principle should apply not just to this library itself but to third-party dependencies. At present, this library has one dependency ([oauth](https://rubygems.org/gems/oauth)) and I’d like to keep it that way. If anything, it should have fewer.
+In the immortal words of [Ezra Zygmuntowicz](https://github.com/ezmobius) and his [Merb](https://github.com/merb) project (may they both rest in peace):
+
+> No code is faster than no code.
 
-The tests for the previous version of this library ran in about 2 seconds. That sounds pretty fast until you see that tests for this library run in 2 hundredths of a second. This means you can automatically run the tests any time you write a file and receive immediate feedback. For such of workflows, 2 seconds feels painfully slow. At the same time, we aim to maintain 100% C0 code coverage.
+The fastest code is the code that is never executed because it doesn’t exist. That principle should apply not just to this library itself but to third-party dependencies. At present, this library has no runtime dependencies and I’d like to keep it that way.
 
-This code is not littered with comments that are intended to generate documentation. Rather, this code is intended to be simple enough to serve as its own documentation. If you want to understand how something works, don’t read the documentation—it might be wrong—just read the code. The code is always right.
+The tests for the previous version of this library executed in about 2 seconds. That sounds pretty fast until you see that tests for this library run in 2 hundredths of a second. This means you can automatically run the tests any time you write a file and receive immediate feedback. For such of workflows, 2 seconds feels painfully slow.
 
-This project conforms to [Standard Ruby](https://github.com/standardrb/standard). Patches that don’t maintain that standard will not be accepted.
+This code is not littered with comments that are intended to generate documentation. Rather, this code is intended to be simple enough to serve as its own documentation. If you want to understand how something works, don’t read the documentation—it might be wrong—read the code. The code is always right.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+1. Checkout and repo:
+
+       git checkout git@github.com:sferik/x-ruby.git
+
+2. Enter the repo’s directory:
+
+       cd x-ruby
+
+3. Install dependencies via Bundler:
+
+       bin/setup
+
+4. Run the default Rake task to ensure all tests pass:
+
+       bundle exec rake
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+5. Create a new branch for your feature or bug fix:
+
+       git checkout -b my-new-branch
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/x.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/x-ruby.
+
+Pull requests will only be accepted if they meet all the following criteria:
+
+1. Code must conform to [Standard Ruby](https://github.com/standardrb/standard). This can be verified with:
+
+       bundle exec rake standard
+
+2. For any new code paths, tests must be added to maintain 100% C0 code coverage. This can be verified with:
+
+       bundle exec rake test
+
+3. For any new classes or methods, RBS type signatures must be added (to sig/x.rbs). This can be verified with:
+
+       bundle exec rake steep
 
 ## License
 

data/Steepfile

@@ -1,9 +1,13 @@
 target :lib do
   signature "sig"
   check "lib"
+  library "base64"
+  library "cgi"
   library "forwardable"
   library "json"
   library "net-http"
+  library "openssl"
+  library "securerandom"
   library "uri"
   configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
 end

data/lib/x/authenticator.rb

@@ -1,27 +1,81 @@
-require "oauth"
-require "forwardable"
+require "base64"
+require "cgi"
+require "json"
+require "openssl"
+require "securerandom"
+require "uri"
 
 module X
   # Handles OAuth authentication
   class Authenticator
-    extend Forwardable
+    attr_accessor :api_key, :api_key_secret, :access_token, :access_token_secret
 
-    def_delegator :@access_token, :secret, :access_token_secret
-    def_delegator :@access_token, :secret=, :access_token_secret=
-    def_delegator :@access_token, :token, :access_token
-    def_delegator :@access_token, :token=, :access_token=
-    def_delegator :@consumer, :key, :api_key
-    def_delegator :@consumer, :key=, :api_key=
-    def_delegator :@consumer, :secret, :api_key_secret
-    def_delegator :@consumer, :secret=, :api_key_secret=
+    OAUTH_VERSION = "1.0".freeze
+    OAUTH_SIGNATURE_METHOD = "HMAC-SHA1".freeze
 
     def initialize(api_key, api_key_secret, access_token, access_token_secret)
-      @consumer = OAuth::Consumer.new(api_key, api_key_secret, site: ClientDefaults::DEFAULT_BASE_URL)
-      @access_token = OAuth::Token.new(access_token, access_token_secret)
+      @api_key = api_key
+      @api_key_secret = api_key_secret
+      @access_token = access_token
+      @access_token_secret = access_token_secret
     end
 
     def sign!(request)
-      @consumer.sign!(request, @access_token)
+      method = request.method
+      uri, query_params = split_uri(request.uri)
+      request.add_field("Authorization", oauth_header(method, uri, query_params))
+    end
+
+    private
+
+    def split_uri(uri)
+      uri_base = uri.path.to_s
+      query_params = URI.decode_www_form(uri.query.to_s).to_h
+      [uri_base, query_params]
+    end
+
+    def oauth_header(method, uri, query_params)
+      oauth_params = default_oauth_params
+      all_params = query_params.merge(oauth_params)
+      oauth_params["oauth_signature"] = generate_signature(method, uri, all_params)
+      formatted_oauth_header(oauth_params)
+    end
+
+    def default_oauth_params
+      {
+        "oauth_consumer_key" => @api_key,
+        "oauth_nonce" => SecureRandom.hex,
+        "oauth_signature_method" => OAUTH_SIGNATURE_METHOD,
+        "oauth_timestamp" => Time.now.utc.to_i.to_s,
+        "oauth_token" => @access_token,
+        "oauth_version" => OAUTH_VERSION
+      }
+    end
+
+    def generate_signature(method, uri, params)
+      Base64.encode64(OpenSSL::HMAC.digest(
+        OpenSSL::Digest.new("sha1"),
+        signing_key,
+        signature_base_string(method, uri, params)
+      )).chomp
+    end
+
+    def signature_base_string(method, uri, params)
+      encoded_params = encode_params(params)
+      "#{method}&#{CGI.escape(uri)}&#{CGI.escape(encoded_params)}"
+    end
+
+    def encode_params(params)
+      # TODO: Replace CGI.escape with CGI.escapeURIComponent when support for Ruby 3.1 is dropped
+      params.sort.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&").gsub("+", "%20")
+    end
+
+    def signing_key
+      "#{CGI.escape(@api_key_secret)}&#{CGI.escape(@access_token_secret)}"
+    end
+
+    def formatted_oauth_header(params)
+      "OAuth #{params.sort.map { |k, v| "#{k}=\"#{CGI.escape(v.to_s)}\"" }.join(", ")}"
     end
   end
 end

data/lib/x/version.rb

@@ -1,5 +1,5 @@
 require "rubygems/version"
 
 module X
-  VERSION = Gem::Version.create("0.6.0")
+  VERSION = Gem::Version.create("0.7.0")
 end

data/sig/x.rbs

@@ -1,23 +1,26 @@
-module OAuth
-  class Consumer
-    def initialize: (String api_key, String api_key_secret, site: String) -> void
-    def sign!: (Net::HTTPRequest request, OAuth::Token token) -> void
-  end
-  class Token
-    def initialize: (String access_token, String access_token_secret) -> void
-  end
-end
-
 module X
   VERSION: Gem::Version
 
   class Authenticator
-    extend Forwardable
-    @consumer: OAuth::Consumer
-    @access_token: OAuth::Token
+    OAUTH_VERSION: String
+    OAUTH_SIGNATURE_METHOD: String
 
+    attr_accessor api_key: String
+    attr_accessor api_key_secret: String
+    attr_accessor access_token: String
+    attr_accessor access_token_secret: String
     def initialize: (String api_key, String api_key_secret, String access_token, String access_token_secret) -> void
     def sign!: (Net::HTTPRequest request) -> void
+
+    private
+    def split_uri: (URI::Generic uri) -> [String, Hash[String, String]]
+    def oauth_header: (String method, String uri, Hash[String, String] query_params) -> String
+    def default_oauth_params: -> Hash[String, String]
+    def generate_signature: (String method, String uri, Hash[String, String] params) -> String
+    def signature_base_string: (String method, String uri, Hash[String, String] params) -> String
+    def encode_params: (Hash[String, String] params) -> String
+    def signing_key: -> String
+    def formatted_oauth_header: (Hash[String, String] params) -> String
   end
 
   module ClientDefaults

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: oauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+date: 2023-09-02 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 - sferik@gmail.com
@@ -58,12 +44,12 @@ files:
 - lib/x/response_handler.rb
 - lib/x/version.rb
 - sig/x.rbs
-homepage: https://github.com/sferik/x-ruby
+homepage: https://sferik.github.io/x-ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/sferik/x-ruby
+  homepage_uri: https://sferik.github.io/x-ruby
   source_code_uri: https://github.com/sferik/x-ruby
   changelog_uri: https://github.com/sferik/x-ruby/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'