twitter_labs_api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a581a41b57bc11fb7f01964a03c13c9e7923ee0813250ad582bc853591cc0275
-  data.tar.gz: 226af47431ababbb840a112b27c4fe31ee485c039739c7f0251b69e63ed6fcfd
+  metadata.gz: 471a4a8a8b2f248f11d0337240451d5b5bc2fdff5601370335f0ab080038cb0a
+  data.tar.gz: 25f2097f036e2ba1b9431f5e4a01db6a062ea7507f05b648c85b9d3514c5d083
 SHA512:
-  metadata.gz: dba4c0c8c92b3a220ebf50cf94c8257a4d1c36bf5c672fabea8df14afa8afe1bfab3c5dfb24878bc0b49bf3b26e617f6ca1d83717a0f261f41d2b014d022463d
-  data.tar.gz: ef93fc47a585d98df6ef64e98a5a6f108caed74b3680bea093532ea52a4520809b1a26286176f5f864df8f99291e00fbe03079b1795bb701159a2bad91fa89cf
+  metadata.gz: df432778d2baef5046f1c0d36ddd1b96f17e58414063ce3e76f15fdb9d7f78abc82327c598bc2a0e67fc3e205a430c5e5f851e1afb16691176a5722e506fe226
+  data.tar.gz: bcad0b98629f789f004974fdc505929b7a7f42af362490a8d9bd5e3ade4389ae770e25cf1550cd46af308f3336b2c4f3018a71580e41e9f92e48d42d1aea5fca

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem 'activesupport'
 gem 'httplog'
+gem 'pry'

data/Gemfile.lock

@@ -1,31 +1,36 @@
 PATH
   remote: .
   specs:
-    twitter_labs_api (0.3.1)
+    twitter_labs_api (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     httplog (1.3.2)
       rack (>= 1.0)
       rainbow (>= 2.0.0)
-    i18n (1.6.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    rack (2.2.2)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -34,8 +39,9 @@ DEPENDENCIES
   activesupport
   bundler (~> 2.0)
   httplog
+  pry
   rake (~> 13.0)
   twitter_labs_api!
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -40,6 +40,21 @@ api.get_tweet(id: '1235508591232090112', tweet_fields: my_fields)
 >> {"author_id"=>"229708614", "created_at"=>"2020-03-05T10:12:57.000Z", "id"=>"1235508591232090112", "text"=>"Hot take: coronavirus will not boost remote work in the long run because spur-of-the-moment work-from-home for in-person companies is likely to be a shitshow."}
 ```
 
+#### 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:
+
+```ruby
+def my_twitter_request
+  api.get_tweet(id: '1235508591232090112', tweet_fields: my_fields)
+
+rescue TwitterLabsAPI::APIError => e
+  puts e.msg # 429 Too Many Requests
+  puts e.response # <Net::HTTPTooManyRequests 429 Too Many Requests readbody=true>
+  # do something with the Net::HTTP response...
+end
+```
+
 ### Status
 Currently, the following endpoints are implemented:
 

data/lib/twitter_labs_api.rb

@@ -10,7 +10,17 @@ DEFAULT_USER_FIELDS = %w[name username].freeze
 class TwitterLabsAPI
   attr_accessor :bearer_token, :debug, :api_response, :parsed_response
 
-  class TwitterLabsAPIError < StandardError; end
+  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
 
   def initialize(bearer_token:, debug: false)
     @bearer_token = bearer_token
@@ -77,7 +87,7 @@ class TwitterLabsAPI
       http.request(request)
     end
 
-    raise(TwitterLabsAPIError, "#{api_response.code} #{api_response.msg}") unless api_response.is_a?(Net::HTTPSuccess)
+    raise_http_error unless api_response.is_a?(Net::HTTPSuccess)
 
     self.parsed_response = JSON.parse(api_response.body)
 
@@ -98,9 +108,13 @@ class TwitterLabsAPI
     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 TwitterLabsAPIError, "#{error['title']}: #{error['detail']} #{error['type']}"
+    raise APIError.new("#{error['title']}: #{error['detail']} #{error['type']}", api_response)
   end
 end

data/lib/twitter_labs_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_labs_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - tomholford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler