instagram_basic_display_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e7b67095cbeb00fa16bac4a65d026c6103aa5d7
-  data.tar.gz: 1c107ab2fc453fc8ea07a96f6a2f40768166bb10
+SHA256:
+  metadata.gz: 852278006c3aba2b7b380d04ac6689758074d57289e231422670497d529acce5
+  data.tar.gz: ebda7e248c2764f4e8dd7ede9d7a75eca2eba4adf9cb957776b30329881fc7cb
 SHA512:
-  metadata.gz: 129a60a0f7a7a5c8c2023d7f75723a6bea959a3a138c81b609e5aae222a0c297c9199fa447dcfae7f11014e6ac26ef81cb69a5df6e797226b9959d24327632bb
-  data.tar.gz: fd927248020413309ed4ee09a4387acda38720ed552f1be4c698222f1d340d0ddb4a3b562574e5c54d3a5e8620923ff2a0309cea2b2b7f0ea5c958aa3fc8f3a3
+  metadata.gz: 004d8198ccc6d640487df8fc5a9b913140907749a7966a2f248441346774caa55d4ce25a038db9ceeece5a0b47c32de1fb5aaa46a002c890e5da36a21e13c95f
+  data.tar.gz: fb734308b4f3976f348a7b60274a9d4fab2337ea7074dd41394284351cceb2743e9d078515bc600b8032185b959ef85dd1fec37429ec6230e574e049e3a62b12

data/lib/instagram_basic_display_api.rb

@@ -1,3 +1,4 @@
+require 'instagram_basic_display_api/error'
 require 'instagram_basic_display_api/configuration'
 require 'instagram_basic_display_api/api'
 require 'instagram_basic_display_api/client'

data/lib/instagram_basic_display_api/client/media.rb

@@ -6,7 +6,6 @@ module InstagramBasicDisplayAPI
         id = args.first
         fields = options[:fields] || 'id,caption,media_type,media_url,permalink,thumbnail_url,timestamp,username'
         response = connection.get("#{id}?fields=#{fields}&access_token=#{access_token}")
-        puts "media item: #{response.body}"
         response.body
       end
 
@@ -14,9 +13,10 @@ module InstagramBasicDisplayAPI
         options = args.last.is_a?(Hash) ? args.pop : {}
         id = args.first
         fields = options[:fields] || 'id,media_type,media_url,permalink,thumbnail_url,timestamp,username'
-        response = connection.get("#{id}/children?fields=#{fields}&access_token=#{access_token}")
-        puts "media children: #{response.body.data}"
-        response.body.data
+        limit = options[:limit] || ''
+        after = options[:after] || ''
+        response = connection.get("#{id}/children?fields=#{fields}&access_token=#{access_token}&limit=#{limit}&after=#{after}")
+        response.body
       end
     end
   end

data/lib/instagram_basic_display_api/client/users.rb

@@ -13,9 +13,11 @@ module InstagramBasicDisplayAPI
         options = args.last.is_a?(Hash) ? args.pop : {}
         id = args.first || 'me'
         fields = options[:fields] || 'id,caption,media_type,media_url,permalink,thumbnail_url,timestamp,username'
-        response = connection.get("#{id}/media?fields=#{fields}&access_token=#{access_token}")
-        # puts "user recent media: #{response.body.data}"
-        response.body.data
+        limit = options[:limit] || ''
+        after = options[:after] || ''
+        url = "#{id}/media?fields=#{fields}&access_token=#{access_token}&limit=#{limit}&after=#{after}"
+        response = connection.get(url)
+        response.body
       end
     end
   end

data/lib/instagram_basic_display_api/connection.rb

@@ -1,5 +1,6 @@
 require 'faraday_middleware'
 require 'ostruct'
+require 'instagram_basic_display_api/raise_http_exception'
 
 module InstagramBasicDisplayAPI
   module Connection
@@ -7,6 +8,7 @@ module InstagramBasicDisplayAPI
       Faraday.new endpoint do |conn|
         # conn.response :json, content_type: /\bjson$/
         conn.response :json, content_type: /\bjson$/, parser_options: { object_class: OpenStruct }
+        conn.use InstagramBasicDisplayAPI::RaiseHttpException
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/instagram_basic_display_api/error.rb

@@ -0,0 +1,34 @@
+module InstagramBasicDisplayAPI
+  # Custom error class for rescuing from all Instagram errors
+  class Error < StandardError; end
+
+  # Raised when Instagram returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Instagram returns the HTTP status code 403
+  class Forbidden < Error; end
+
+  # Raised when Instagram returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Instagram returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when Instagram returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Instagram returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Instagram returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Instagram returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+
+  # Raised when Instagram returns the HTTP status code 429
+  class RateLimitExceeded < Error; end
+end

data/lib/instagram_basic_display_api/raise_http_exception.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+
+# @private
+module InstagramBasicDisplayAPI
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise InstagramBasicDisplayAPI::BadRequest, error_message_400(response)
+        when 403
+          raise InstagramBasicDisplayAPI::Forbidden, error_message_400(response)
+        when 404
+          raise InstagramBasicDisplayAPI::NotFound, error_message_400(response)
+        when 429
+          raise InstagramBasicDisplayAPI::TooManyRequests, error_message_400(response)
+        when 500
+          raise InstagramBasicDisplayAPI::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 502
+          raise InstagramBasicDisplayAPI::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+        when 503
+          raise InstagramBasicDisplayAPI::ServiceUnavailable, error_message_500(response, "Instagram is rate limiting your requests.")
+        when 504
+          raise InstagramBasicDisplayAPI::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        # removed multi_json thanks to wesnolte's commit
+        if body == "Sorry, this content isn't available right now"
+          body
+        else
+          body = ::JSON.parse(body)
+        end
+      end
+
+      if body.nil?
+        nil
+      elsif body['error'] and body['error']['message'] and not body['error']['message'].empty?
+        ": #{body['error']['message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

data/spec/media_spec.rb

@@ -17,7 +17,7 @@ describe InstagramBasicDisplayAPI::Client do
     describe '.media_children' do
       it 'should return list of children media for the given media item' do
         media = @client.media_children(ENV['MEDIA_ID'])
-        expect(media.first.username).to eq(ENV['USERNAME'])
+        expect(media.data.first.username).to eq(ENV['USERNAME'])
       end
     end
   end

data/spec/users_spec.rb

@@ -27,16 +27,16 @@ describe InstagramBasicDisplayAPI::Client do
       context 'with user ID passed' do
         it 'should return a list of recent media items for the given user' do
           recent_media = @client.user_recent_media('me')
-          expect(recent_media).to be_a Array
-          expect(recent_media.first.username).to eq(ENV['USERNAME'])
+          expect(recent_media.data).to be_a Array
+          expect(recent_media.data.first.username).to eq(ENV['USERNAME'])
         end
       end
 
       context 'without user ID passed' do
         it 'should return a list of recent media items for the given user' do
           recent_media = @client.user_recent_media
-          expect(recent_media).to be_a Array
-          expect(recent_media.first.username).to eq(ENV['USERNAME'])
+          expect(recent_media.data).to be_a Array
+          expect(recent_media.data.first.username).to eq(ENV['USERNAME'])
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instagram_basic_display_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Craig Phares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,6 +92,8 @@ files:
 - lib/instagram_basic_display_api/client/users.rb
 - lib/instagram_basic_display_api/configuration.rb
 - lib/instagram_basic_display_api/connection.rb
+- lib/instagram_basic_display_api/error.rb
+- lib/instagram_basic_display_api/raise_http_exception.rb
 - spec/media_spec.rb
 - spec/users_spec.rb
 homepage: https://github.com/sixoverground/instagram_basic_display_api
@@ -113,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Instagram Basic Display API