x 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 480eb23ebeb098bcc5c2d4924279d2d4608f8cf2a8e5eb7897edf45cc0311bc4
+  data.tar.gz: c97f4694a91b3d3ad9f60d55001d48080329254d28db75aff74d646264fe38f2
+SHA512:
+  metadata.gz: 86adf1889c2e820353c4455a08c443480682d4827addd074a7e1fe3e60937e70b638118d31802c8cc57d457865c917d2f1a83d739448659519f42c9cbede74ed
+  data.tar.gz: 714dcea3deff757a2d15548ed1fdbb17749ca5b901e9463a5b3a223120b05974ab792d1c3230406dc07984358a6d9e7c4d781402aa025fa5e257d967ee5ecbcf

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+ - rubocop-minitest
+ - rubocop-performance
+ - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in x.gemspec
+gemspec
+
+gem "minitest", ">= 5.19"
+gem "rake", ">= 13.0.6"
+gem "rubocop", ">= 1.21"
+gem "rubocop-minitest", ">= 0.31"
+gem "rubocop-performance", ">= 1.18"
+gem "rubocop-rake", ">= 0.6"
+gem "webmock", ">= 3.18.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Erik Berlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# X
+
+A Ruby interface to the X 2.0 API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add x
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install x
+
+## Usage
+
+```ruby
+api_key = "YOUR_X_API_KEY"
+api_key_secret = "YOUR_X_API_KEY_SECRET"
+access_token = "YOUR_X_ACCESS_TOKEN"
+access_token_secret = "YOUR_X_ACCESS_TOKEN_SECRET"
+
+x_client = X::Client.new(api_key: api_key, api_key_secret: api_key_secret, access_token: access_token, access_token_secret: access_token_secret)
+
+begin
+  response = x_client.get("users/me")
+  puts JSON.pretty_generate(response)
+rescue StandardError => e
+  puts "Error: #{e.message}"
+end
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/x.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/x/client.rb

@@ -0,0 +1,95 @@
+require "oauth"
+require "json"
+require "net/http"
+
+module X
+  # Main client that handles HTTP authentication and requests
+  class Client
+    BASE_URL = "https://api.twitter.com/2/".freeze
+    HTTP_METHODS = {
+      get: Net::HTTP::Get,
+      post: Net::HTTP::Post,
+      put: Net::HTTP::Put,
+      delete: Net::HTTP::Delete
+    }.freeze
+
+    def initialize(bearer_token: nil, api_key: nil, api_key_secret: nil, access_token: nil, access_token_secret: nil)
+      @use_bearer_token = !bearer_token.nil?
+
+      if @use_bearer_token
+        @bearer_token = bearer_token
+      else
+        unless api_key && api_key_secret && access_token && access_token_secret
+          raise ArgumentError, "Missing OAuth credentials."
+        end
+
+        @consumer = OAuth::Consumer.new(api_key, api_key_secret, site: BASE_URL)
+        @access_token = OAuth::Token.new(access_token, access_token_secret)
+      end
+    end
+
+    def get(endpoint)
+      response = send_request(:get, endpoint)
+      handle_response(response)
+    end
+
+    def post(endpoint, body = nil)
+      response = send_request(:post, endpoint, body)
+      handle_response(response)
+    end
+
+    def put(endpoint, body = nil)
+      response = send_request(:put, endpoint, body)
+      handle_response(response)
+    end
+
+    def delete(endpoint)
+      response = send_request(:delete, endpoint)
+      handle_response(response)
+    end
+
+    private
+
+    def send_request(http_method, endpoint, body = nil)
+      url = URI.parse(BASE_URL + endpoint)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = create_request(http_method, url, body)
+      add_authorization(request)
+
+      http.request(request)
+    end
+
+    def create_request(http_method, url, body)
+      http_method_class = HTTP_METHODS[http_method]
+
+      raise ArgumentError, "Unsupported HTTP method: #{http_method}" unless http_method_class
+
+      request = http_method_class.new(url)
+      request.body = body if body && http_method != :get
+      request
+    end
+
+    def add_authorization(request)
+      if @use_bearer_token
+        request["Authorization"] = "Bearer #{@bearer_token}"
+      else
+        @consumer.sign!(request, @access_token)
+      end
+    end
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      when Net::HTTPUnauthorized
+        raise X::AuthenticationError, "Authentication failed. Please check your credentials."
+      when Net::HTTPServerError
+        raise X::ServerError, "An internal server error occurred."
+      else
+        raise X::Error, "Unexpected response: #{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/x/error.rb

@@ -0,0 +1,5 @@
+module X
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ServerError < Error; end
+end

data/lib/x/version.rb

@@ -0,0 +1,3 @@
+module X
+  VERSION = "0.1.0".freeze
+end

data/lib/x.rb

@@ -0,0 +1,3 @@
+require_relative "x/version"
+require_relative "x/client"
+require_relative "x/error"

data/sig/x.rbs

@@ -0,0 +1,4 @@
+module X
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: x
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Berlin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-02 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'
+description:
+email:
+- sferik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/x.rb
+- lib/x/client.rb
+- lib/x/error.rb
+- lib/x/version.rb
+- sig/x.rbs
+homepage: https://github.com/sferik/x-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sferik/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'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: A Ruby interface to the X 2.0 API.
+test_files: []