twitter_labs_api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471a4a8a8b2f248f11d0337240451d5b5bc2fdff5601370335f0ab080038cb0a
-  data.tar.gz: 25f2097f036e2ba1b9431f5e4a01db6a062ea7507f05b648c85b9d3514c5d083
+  metadata.gz: f31f636cbf46ed53a3d35e61c3376b9f47184220db4b23277f4f7c504f4be251
+  data.tar.gz: be3ae4940e263fe6bf33661686072c62c807236f9c2814488661efc8da8799a8
 SHA512:
-  metadata.gz: df432778d2baef5046f1c0d36ddd1b96f17e58414063ce3e76f15fdb9d7f78abc82327c598bc2a0e67fc3e205a430c5e5f851e1afb16691176a5722e506fe226
-  data.tar.gz: bcad0b98629f789f004974fdc505929b7a7f42af362490a8d9bd5e3ade4389ae770e25cf1550cd46af308f3336b2c4f3018a71580e41e9f92e48d42d1aea5fca
+  metadata.gz: 6062719f695c9979a327d94396795df7365559e92598fe08e727d2e87dc2e4a987a4f6bf689954cd2efc2b6c20f0ad5ae3003f651e0e45fc0caea12f46a57688
+  data.tar.gz: 7c1616a9f97582a2dda4061f2a0c540b7967d4d525c0bd344141643723450d91a4208357d919b8acf4d0d89a17d2046e0f6fba75a5c3eb6e9a10d9f6caa4df31

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.5.0 - 27 July 2020
+
+- Refactor structure to prepare for adding additional API endpoints
+- Add `get_users_by_username`
+- Add some test coverage
+
+
+# 0.4.0 - 24 July 2020
+
+- Better exception-handling: when API returns an error, a `TwitterLabsAPI::APIError` is thrown. It has the `Net::HTTP` response as an attribute so that the error can be handled properly. See the README for an example.
+
+
 # 0.3.0 - 28 April 2020
 
 - Fix: namespace of error class

data/Gemfile

@@ -1,7 +1,13 @@
 source 'https://rubygems.org'
 
-gemspec
+group :development, :test do
+  gem 'amazing_print'
+  gem 'httplog'
+  gem 'irbtools'
+  gem 'pry'
+  gem 'rake'
+  gem 'rspec'
+  gem 'webmock'
+end
 
-gem 'activesupport'
-gem 'httplog'
-gem 'pry'
+gemspec

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    twitter_labs_api (0.4.0)
+    twitter_labs_api (0.5.0)
+      activesupport (~> 6.0)
+      httplog (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
@@ -12,36 +14,121 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    alias (0.2.3)
+    amazing_print (1.2.1)
+    binding.repl (3.0.0)
+    boson (1.3.0)
+    boson-more (0.3.1)
+      boson (>= 1.3.0)
+    cd (1.0.1)
+    clipboard (1.0.6)
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
-    httplog (1.3.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    debugging (1.1.1)
+      binding.repl (~> 3.0)
+      paint (>= 0.9, < 3.0)
+    diff-lcs (1.4.4)
+    every_day_irb (2.1.0)
+      cd (~> 1.0)
+    fancy_irb (1.2.1)
+      paint (>= 0.9, < 3.0)
+      unicode-display_width (~> 1.1)
+    ffi (1.13.1)
+    g (1.7.2)
+    hashdiff (1.0.1)
+    hirb (0.7.3)
+    httplog (1.4.3)
       rack (>= 1.0)
       rainbow (>= 2.0.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    interactive_editor (0.0.11)
+      spoon (>= 0.0.1)
+    irbtools (1.7.1)
+      alias (~> 0.2.3)
+      binding.repl (~> 3.0)
+      boson (~> 1.3.0)
+      boson-more (~> 0.3.0)
+      clipboard (~> 1.0.5)
+      coderay (~> 1.1.0)
+      debugging (~> 1.0)
+      every_day_irb (>= 1.7.1)
+      fancy_irb (>= 0.7.3)
+      g (>= 1.7.2)
+      hirb (~> 0.7, >= 0.7.3)
+      interactive_editor (>= 0.0.10)
+      method_locator (>= 0.0.4)
+      method_source (>= 0.8.2)
+      methodfinder (~> 2.0)
+      ori (~> 0.1.0)
+      os (~> 0.9)
+      paint (>= 0.8.7)
+      ruby_engine (~> 1.0)
+      ruby_info (~> 1.0)
+      ruby_version (~> 1.0)
+      wirb (>= 1.0.3)
+    method_locator (0.0.4)
     method_source (1.0.0)
+    methodfinder (2.2.1)
     minitest (5.14.1)
+    ori (0.1.0)
+    os (0.9.6)
+    paint (2.2.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.5)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby_engine (1.0.1)
+    ruby_info (1.0.1)
+    ruby_version (1.0.2)
+    safe_yaml (1.0.5)
+    spoon (0.0.6)
+      ffi
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    wirb (2.2.1)
+      paint (>= 0.9, < 3.0)
     zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
+  amazing_print
   bundler (~> 2.0)
   httplog
+  irbtools
   pry
-  rake (~> 13.0)
+  rake
+  rspec
   twitter_labs_api!
+  webmock
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -19,7 +19,7 @@ gem install twitter_labs_api
 
 #### Getting a Tweet by ID
 ```ruby
-requre `twitter_labs_api`
+require `twitter_labs_api`
 
 api = TwitterLabsAPI.new(bearer_token: 'YOUR-BEARER-TOKEN')
 
@@ -42,7 +42,7 @@ api.get_tweet(id: '1235508591232090112', tweet_fields: my_fields)
 
 #### API Errors
 
-Sometimes the API will respond with an error, for example `429 Too Many Requests`. The gem will throw an error with the `Net::HTTP` response as an attribute for proper exception-handling by the consuming app:
+Sometimes the API will respond with an error, for example, `429 Too Many Requests`. The gem will throw an error with the `Net::HTTP` response as an attribute for proper exception-handling by the consuming app:
 
 ```ruby
 def my_twitter_request
@@ -58,14 +58,20 @@ end
 ### Status
 Currently, the following endpoints are implemented:
 
-- `TwitterLabsAPI#get_tweet` - Retrieve a single Tweet object with an `id`
-- `TwitterLabsAPI#get_tweets` - Retrieve multiple Tweets with a collection of `ids`
-- `TwitterLabsAPI#get_user` - Retrieve a single user object with an `id`
-- `TwitterLabsAPI#get_users` - Retrieve multiple user objects with a collection of `ids`
+#### Tweets
+
+- `TwitterLabsAPI#get_tweet` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-tweets-id)) - Retrieve a single Tweet object with an `id`
+- `TwitterLabsAPI#get_tweets` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-tweets)) - Retrieve multiple Tweets with a collection of `ids`
+
+#### Users
+
+- `TwitterLabsAPI#get_user` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-users-id)) - Retrieve a single user object with an `id`
+- `TwitterLabsAPI#get_users` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-users)) - Retrieve multiple user objects with a collection of `ids`
+- `TwitterLabsAPI#get_users_by_username` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-users)) - Retrieve multiple user objects with a collection of `usernames`
 
 ## Roadmap
 
-Since this project is initially driven by my own usage of the API, I will focus on implementing and refinining the Tweets, Users, and Metrics endpoints. If this repo gets enough interest, I might implement the other endpoints and create a proper `.gemspec`. And of course, contributions are welcome :)
+Since this project is initially driven by my own usage of the API, I will focus on implementing and refining the Tweets, Users, and Metrics endpoints. If this repo gets enough interest, I might implement the other endpoints and create a proper `.gemspec`. And of course, contributions are welcome :)
 
 ## Dependencies
 

data/bin/specs

@@ -0,0 +1 @@
+bundle exec rspec

data/lib/twitter_labs_api.rb

@@ -2,119 +2,13 @@ require 'json'
 require 'net/http'
 require 'uri'
 require 'active_support/core_ext/hash/indifferent_access'
-
-DEFAULT_TWEET_FIELDS = %w[id author_id created_at lang public_metrics].freeze
-DEFAULT_USER_FIELDS = %w[name username].freeze
+require_relative 'twitter_labs_api/client'
 
 # A basic implementation of a Twitter Labs API client.
-class TwitterLabsAPI
-  attr_accessor :bearer_token, :debug, :api_response, :parsed_response
-
-  class APIError < StandardError
-    DEFAULT_MESSAGE = 'Twitter Labs API error, check the response attribute'.freeze
-
-    attr_reader :response
-
-    def initialize(msg = DEFAULT_MESSAGE, response = nil)
-      @response = response
-
-      super(msg)
+module TwitterLabsAPI
+  class << self
+    def new(bearer_token:, debug: false)
+      Client.new(bearer_token: bearer_token, debug: debug)
     end
   end
-
-  def initialize(bearer_token:, debug: false)
-    @bearer_token = bearer_token
-    @debug = debug
-    require 'httplog' if debug
-  end
-
-  # @param [String] :id the ID of the requested Tweet
-  # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
-  def get_tweet(id:, tweet_fields: DEFAULT_TWEET_FIELDS)
-    url = "https://api.twitter.com/labs/2/tweets/#{id}"
-    params = {
-      'tweet.fields' => tweet_fields.join(',')
-    }.compact
-
-    make_request(url: url, params: params)
-  end
-
-  # @param [Array<String>] :ids the collection of requested Tweet IDs
-  # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
-  def get_tweets(ids:, tweet_fields: DEFAULT_TWEET_FIELDS)
-    url = 'https://api.twitter.com/labs/2/tweets'
-    params = {
-      'ids' => ids.join(','),
-      'tweet.fields' => tweet_fields.join(',')
-    }.compact
-
-    make_request(url: url, params: params, is_collection: true)
-  end
-
-  # @param [String] :id the ID of the requested User
-  # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
-  def get_user(id:, user_fields: DEFAULT_USER_FIELDS)
-    url = "https://api.twitter.com/labs/2/users/#{id}"
-    params = {
-      'user.fields' => user_fields.join(',')
-    }.compact
-
-    make_request(url: url, params: params)
-  end
-
-  # @param [Array<String>] :ids the collection of requested User IDs
-  # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
-  def get_users(ids:, user_fields: DEFAULT_USER_FIELDS)
-    url = 'https://api.twitter.com/labs/2/users'
-    params = {
-      'ids' => ids.join(','),
-      'user.fields' => user_fields.join(',')
-    }.compact
-
-    make_request(url: url, params: params, is_collection: true)
-  end
-
-  private
-
-  def make_request(url:, params: {}, is_collection: false)
-    uri = URI.parse(url)
-    uri.query = URI.encode_www_form(params)
-    request = Net::HTTP::Get.new(uri)
-    request['Authorization'] = "Bearer #{bearer_token}"
-    req_options = { use_ssl: uri.scheme == 'https' }
-
-    self.api_response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-      http.request(request)
-    end
-
-    raise_http_error unless api_response.is_a?(Net::HTTPSuccess)
-
-    self.parsed_response = JSON.parse(api_response.body)
-
-    handle_api_error if error_response?
-
-    is_collection ? handle_collection : handle_single
-  end
-
-  def error_response?
-    parsed_response.key?('errors')
-  end
-
-  def handle_single
-    parsed_response['data'].with_indifferent_access
-  end
-
-  def handle_collection
-    parsed_response['data'].map(&:with_indifferent_access)
-  end
-
-  def raise_http_error
-    raise(APIError.new("#{api_response.code} #{api_response.msg}", api_response))
-  end
-
-  def handle_api_error
-    error = parsed_response['errors'].first
-
-    raise APIError.new("#{error['title']}: #{error['detail']} #{error['type']}", api_response)
-  end
 end

data/lib/twitter_labs_api/api_error.rb

@@ -0,0 +1,13 @@
+module TwitterLabsAPI
+  class APIError < StandardError
+    DEFAULT_MESSAGE = 'Twitter Labs API error, check the response attribute'.freeze
+  
+    attr_reader :response
+  
+    def initialize(msg = DEFAULT_MESSAGE, response = nil)
+      @response = response
+  
+      super(msg)
+    end
+  end  
+end

data/lib/twitter_labs_api/client.rb

@@ -0,0 +1,62 @@
+require_relative 'api_error'
+require_relative 'resources/tweet'
+require_relative 'resources/user'
+
+module TwitterLabsAPI
+  class Client
+    include Resources::Tweet
+    include Resources::User
+
+    attr_accessor :bearer_token, :debug, :api_response, :parsed_response
+
+    def initialize(bearer_token:, debug: false)
+      @bearer_token = bearer_token
+      @debug = debug
+      require 'httplog' if debug
+    end
+
+    private
+
+    def make_request(url:, params: {}, is_collection: false)
+      uri = URI.parse(url)
+      uri.query = URI.encode_www_form(params)
+      request = Net::HTTP::Get.new(uri)
+      request['Authorization'] = "Bearer #{bearer_token}"
+      req_options = { use_ssl: uri.scheme == 'https' }
+  
+      self.api_response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+  
+      raise_http_error unless api_response.is_a?(Net::HTTPSuccess)
+  
+      self.parsed_response = JSON.parse(api_response.body)
+  
+      handle_api_error if error_response?
+  
+      is_collection ? handle_collection : handle_single
+    end
+  
+    def error_response?
+      parsed_response.key?('errors')
+    end
+  
+    def handle_single
+      parsed_response['data'].with_indifferent_access
+    end
+  
+    def handle_collection
+      parsed_response['data'].map(&:with_indifferent_access)
+    end
+  
+    def raise_http_error
+      raise(APIError.new("#{api_response.code} #{api_response.msg}", api_response))
+    end
+  
+    def handle_api_error
+      error = parsed_response['errors'].first
+  
+      raise APIError.new("#{error['title']}: #{error['detail']} #{error['type']}", api_response)
+    end
+  end
+end

data/lib/twitter_labs_api/resources/tweet.rb

@@ -0,0 +1,30 @@
+module TwitterLabsAPI
+  module Resources
+    module Tweet
+      DEFAULT_TWEET_FIELDS = %w[id author_id created_at lang public_metrics].freeze
+
+      # @param [String] :id the ID of the requested Tweet
+      # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
+      def get_tweet(id:, tweet_fields: DEFAULT_TWEET_FIELDS)
+        url = "https://api.twitter.com/labs/2/tweets/#{id}"
+        params = {
+          'tweet.fields' => tweet_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params)
+      end
+
+      # @param [Array<String>] :ids the collection of requested Tweet IDs
+      # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
+      def get_tweets(ids:, tweet_fields: DEFAULT_TWEET_FIELDS)
+        url = 'https://api.twitter.com/labs/2/tweets'
+        params = {
+          'ids' => ids.join(','),
+          'tweet.fields' => tweet_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params, is_collection: true)
+      end
+    end
+  end
+end

data/lib/twitter_labs_api/resources/user.rb

@@ -0,0 +1,42 @@
+module TwitterLabsAPI
+  module Resources
+    module User
+      DEFAULT_USER_FIELDS = %w[id name username].freeze
+
+      # @param [String] :id the ID of the requested User
+      # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      def get_user(id:, user_fields: DEFAULT_USER_FIELDS)
+        url = "https://api.twitter.com/labs/2/users/#{id}"
+        params = {
+          'user.fields' => user_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params)
+      end
+
+      # @param [Array<String>] :ids the collection of requested User IDs
+      # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      def get_users(ids:, user_fields: DEFAULT_USER_FIELDS)
+        url = 'https://api.twitter.com/labs/2/users'
+        params = {
+          'ids' => ids.join(','),
+          'user.fields' => user_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params, is_collection: true)
+      end
+
+      # @param [Array<String>] :usernames the collection of requested Usernames
+      # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      def get_users_by_usernames(usernames:, user_fields: DEFAULT_USER_FIELDS)
+        url = 'https://api.twitter.com/labs/2/users/by'
+        params = {
+          'usernames' => usernames.join(','),
+          'user.fields' => user_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params, is_collection: true)
+      end
+    end
+  end
+end

data/lib/twitter_labs_api/version.rb

@@ -1,3 +1,3 @@
-class TwitterLabsAPI
-  VERSION = '0.4.0'.freeze
+module TwitterLabsAPI
+  VERSION = '0.5.0'.freeze
 end

data/twitter-labs-api.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport', '~> 6.0'
+  spec.add_dependency 'httplog', '~> 1.4'
+
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: twitter_labs_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - tomholford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: httplog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -54,7 +84,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/specs
 - lib/twitter_labs_api.rb
+- lib/twitter_labs_api/api_error.rb
+- lib/twitter_labs_api/client.rb
+- lib/twitter_labs_api/resources/tweet.rb
+- lib/twitter_labs_api/resources/user.rb
 - lib/twitter_labs_api/version.rb
 - twitter-labs-api.gemspec
 homepage: https://github.com/tomholford/twitter-labs-api