gogokit 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODI1MWRmMzc2N2UxNDc5MTAxODlkMTA2YmMwNjgwNzFkOWE4OTljNg==
+    OTEzMTlkMzNlMjczMTQ3OTgxYmVlNmUzODA1YTkzODEyYTk2MTdhZg==
   data.tar.gz: !binary |-
-    ZDQ2MTdkMTFiN2Y2NzkzZThjMjY2NDcyMTNkMTU1YWJjZGVkYzM0Yw==
+    YTE1ZWRjOTViOTk5MDkyY2Q5YzAzN2JiNzk1ZTNmNWRlN2RkMjA1OQ==
 SHA512:
   metadata.gz: !binary |-
-    NGY4MWI1N2QxOGQ0NDdhMTI4ZmQ0MzFjNGIyOTI3MGYxNGZmZTAxZTVmOTM0
-    NWFkMGIxN2ZkY2IzNGMwNzViYmRmM2FiMDdkNzQ2Y2RlMzQ0N2YzMDBkNjU1
-    MWYyMzk3N2ZlMDA2Mzk5ZTBhOTRkN2VkYTUwMDYzYjViMzk5NWQ=
+    MzM2ZGVkYzA0ZDRhNTNjYmM5ZjNhM2NiMjY2OGRlOTNlN2ZlZmY2MWMyMTI2
+    MzM2ZTQwODE0NTZhOTJiOTJjOTI0ZmM2N2VlMmJlYzg1MDIzM2M5OGQ2ZmJj
+    NDIxMDQ5ZjA5ODZmNzA0ZmU4NTFjOTY0YWFlMTllMjI4YmUzOGM=
   data.tar.gz: !binary |-
-    MmZmMmE2MzdiMzQ5NzY3YWYxNGI1M2I1MTA3M2FhMzc1YTRkOGMyODRhNmZh
-    M2JiOTQ2ZmEyY2I5MTk4MmUwMTdlMGI2NTBkYWJjYWU5ZTVjOTljMjY3ZWYx
-    YzNiMjgyODU3NDkwM2JhYmRmYTEzNDUwODVlNGJmZmQyOWYxNjU=
+    ODJhY2NhMDU3MzNjNjVjMDY2ZjkyZWIxOTg4YmE1YmVhNzcyYzIxYjA1ODdl
+    OWRiZjAyYjBlNDZjZTMzY2YxZTY0ZmY0NzJkYWZmOTZkY2NiODdhMDc5YjYy
+    MDQ2MjM2OTNmZWU2NTliYjAzOTcyMDgzYzgwYzdkZGNmNDI5NWI=

data/README.md

@@ -18,6 +18,7 @@
 [troubleshootwindows]: https://github.com/jnunemaker/httparty/wiki/Troubleshooting-on-Windows
 [submitanissue]: https://github.com/viagogo/gogokit.rb/issues
 [apidocsgettingstarted]: http://developer.viagogo.net/#getting-started
+[rubysamples]: https://github.com/viagogo/gogokit.rb/tree/master/samples
 
 
 Ruby toolkit for working with the viagogo API. Our [developer site][apidocs]
@@ -37,7 +38,8 @@ Install via Ruby gems
 
 ## Usage
 
-See our [developer site][apidocsgettingstarted] for more examples.
+See our [developer site][apidocsgettingstarted] and
+[samples][rubysamples] for more examples.
 
 ```ruby
 require 'gogokit'
@@ -113,6 +115,15 @@ client.api_root_endpoint
 # => "http://sandbox.api.viagogo.net"
 ```
 
+#### Sandbox Environment
+
+```ruby
+# You can use the GogoKitConfiguration to switch between the sandbox and
+# production environments. See http://developer.viagogo.net/#sandbox-environment
+client = GogoKit::Client.new
+client.api_environment = :sandbox
+```
+
 ## How to contribute
 
 All submissions are welcome. Fork the repository, read the rest of this README

data/lib/gogokit/client.rb

@@ -64,6 +64,7 @@ module GogoKit
       yield self if block_given?
 
       validate_configuration_credentials!
+      validate_configuration_api_environment!
       validate_configuration_endpoints!
     end
 

data/lib/gogokit/client/oauth.rb

@@ -8,6 +8,61 @@ module GogoKit
     module OAuth
       include GogoKit::Utils
 
+      # Gets the URL where applications can obtain a users consent to make API
+      # calls on their behalf.
+      # @see http://developer.viagogo.net/#user-login-authentication-flow
+      # @param [String] redirect_uri Application redirect URL where the
+      # authorization code is sent. This must match the URL registered for your
+      # application.
+      # @param [Array] scopes The scopes that specify the type of access that is
+      # needed.
+      # @param [String] state An opaque value used to maintain state between the
+      # authorize request and the callback.
+      def get_authorization_url(redirect_uri, scopes, state = nil)
+        scope_value = scopes.nil? ? '' : scopes.join('%20')
+        "#{authorization_endpoint}?client_id=#{client_id}&response_type=code&" \
+        "redirect_uri=#{redirect_uri}&scope=#{scope_value}&state=#{state}"
+      end
+
+      # Requests an access token that will provide access to user-specific data
+      # (sales, sellerlistings, webhooks, purchases, etc)
+      # @see http://developer.viagogo.net/#user-login-authentication-flow
+      # @param [String] code The authorization code that was sent to your
+      # applications return URL.
+      # @param [String] redirect_uri Application redirect URL where the
+      # authorization code is sent. This must match the URL registered for your
+      # application.
+      # @param [Array] scopes The scopes that specify the type of access that is
+      # needed.
+      def get_authorization_code_access_token(code,
+                                              redirect_uri,
+                                              scopes,
+                                              options = {})
+        scope_value = scopes.nil? ? '' : scopes.join(' ')
+        merged_options = options.merge(code: code,
+                                       redirect_uri: redirect_uri,
+                                       scope: scope_value)
+        get_access_token('authorization_code', merged_options)
+      end
+
+      # Get an OAuth access token for an application.
+      #
+      # @see http://developer.viagogo.net/#application-only-authentication-flow
+      # @param [Hash] options Token request information
+      # @return [GogoKit::OAuthToken] The OAuth token
+      def get_client_access_token(options = {})
+        get_access_token('client_credentials', options)
+      end
+
+      # Obtain additional access tokens in order to prolong access to a users
+      # data
+      # @param [GogoKit::OAuthToken] token The token to be refreshed.
+      def get_refresh_token(token, options = {})
+        merged_options = options.merge(refresh_token: token.refresh_token,
+                                       scope: token.scope)
+        get_access_token('refresh_token', merged_options)
+      end
+
       # Get an OAuth access token
       #
       # @see http://viagogo.github.io/developer.viagogo.net/#authentication
@@ -23,16 +78,6 @@ module GogoKit
                              headers: token_request_headers)
       end
 
-      # Get an OAuth access token for an application.
-      #
-      # @see
-      # http://viagogo.github.io/developer.viagogo.net/#client-credentials-grant
-      # @param [Hash] options Token request information
-      # @return [GogoKit::OAuthToken] The OAuth token
-      def get_client_access_token(options = {})
-        get_access_token('client_credentials', options)
-      end
-
       private
 
       def token_request_body(grant_type, options)
@@ -43,7 +88,7 @@ module GogoKit
 
       def token_request_headers
         credentials = "#{client_id}:#{client_secret}"
-        basic_header_value = Base64.encode64(credentials).gsub("\n", '')
+        basic_header_value = Base64.encode64(credentials).delete("\n")
         {
           content_type: 'application/x-www-form-urlencoded',
           accept: 'application/json',

data/lib/gogokit/configuration.rb

@@ -9,7 +9,8 @@ module GogoKit
                   :client_secret,
                   :access_token,
                   :api_root_endpoint,
-                  :oauth_token_endpoint
+                  :oauth_token_endpoint,
+                  :authorization_endpoint
 
     # Reset configuration options to default values
     def reset!
@@ -19,6 +20,32 @@ module GogoKit
       self
     end
 
+    # Gets the current API environment in use
+    #
+    # @return [Symbol]
+    # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
+    # environment is not :production or :sandbox.
+    def api_environment
+      @api_environment
+    end
+
+    # Sets the API environment to be used. Setting this value will configure the
+    # values for {GogoKit::Configuration#api_root_endpoint},
+    # {GogoKit::Configuration#oauth_token_endpoint} and
+    # {GogoKit::Configuration#authorization_endpoint}.
+    # See http://developer.viagogo.net/#sandbox-environment
+    def api_environment=(api_environment)
+      @api_environment = api_environment.to_sym
+      validate_configuration_api_environment!
+
+      self.api_root_endpoint =
+        GogoKit::Default::API_ROOT_ENDPOINTS[@api_environment]
+      self.oauth_token_endpoint =
+        GogoKit::Default::OAUTH_TOKEN_ENDPOINTS[@api_environment]
+      self.authorization_endpoint =
+        GogoKit::Default::AUTHORIZATION_ENDPOINTS[@api_environment]
+    end
+
     private
 
     def keys
@@ -26,8 +53,10 @@ module GogoKit
         :client_id,
         :client_secret,
         :access_token,
+        :api_environment,
         :api_root_endpoint,
-        :oauth_token_endpoint
+        :oauth_token_endpoint,
+        :authorization_endpoint
       ]
     end
 
@@ -43,7 +72,8 @@ module GogoKit
     def endpoints
       {
         api_root_endpoint: api_root_endpoint,
-        oauth_token_endpoint: oauth_token_endpoint
+        oauth_token_endpoint: oauth_token_endpoint,
+        authorization_endpoint: authorization_endpoint
       }
     end
 
@@ -55,9 +85,9 @@ module GogoKit
     def validate_configuration_credentials!
       credentials.each do |credential, value|
         next if value.nil? || value.is_a?(String) || value.is_a?(Symbol)
-        fail(ConfigurationError,
-             "Invalid #{credential} specified: #{value.inspect} must be a" \
-             ' string or symbol.')
+        raise(ConfigurationError,
+              "Invalid #{credential} specified: #{value.inspect} must be a" \
+              ' string or symbol.')
       end
     end
 
@@ -65,10 +95,20 @@ module GogoKit
       endpoints.each do |endpoint, value|
         next if !value.nil? && value =~ /\A#{URI.regexp}\z/
 
-        fail(ConfigurationError,
-             "Invalid #{endpoint} specified: " \
-             "#{value.inspect} must be a valid URL")
+        raise(ConfigurationError,
+              "Invalid #{endpoint} specified: " \
+              "#{value.inspect} must be a valid URL")
       end
     end
+
+    def validate_configuration_api_environment!
+      return if api_environment.nil? ||
+                api_environment == :production ||
+                api_environment == :sandbox
+
+      raise(ConfigurationError,
+            'Invalid api_environment specified: ' \
+            "#{api_environment.inspect} must be :production or :sandbox")
+    end
   end
 end

data/lib/gogokit/connection.rb

@@ -6,7 +6,7 @@ module GogoKit
   module Connection
     private
 
-    def connection_options  # rubocop:disable Metrics/MethodLength
+    def connection_options # rubocop:disable Metrics/MethodLength
       @connection_options ||= {
         headers: {
           accept: 'application/hal+json',

data/lib/gogokit/default.rb

@@ -1,11 +1,23 @@
 module GogoKit
   # Default configuration options for {GogoKit::Client}
   module Default
-    # Default API root endpoint
-    API_ROOT_ENDPOINT = 'https://api.viagogo.net/v2'.freeze
+    # Default API root endpoints
+    API_ROOT_ENDPOINTS = {
+      production: 'https://api.viagogo.net/v2'.freeze,
+      sandbox: 'https://sandbox.api.viagogo.net/v2'.freeze
+    }.freeze
 
-    # Default OAuth token endpoint
-    OAUTH_TOKEN_ENDPOINT = 'https://www.viagogo.com/secure/oauth2/token'.freeze
+    # Default OAuth token endpoints
+    OAUTH_TOKEN_ENDPOINTS = {
+      production: 'https://account.viagogo.com/oauth2/token'.freeze,
+      sandbox: 'https://sandbox.account.viagogo.com/oauth2/token'.freeze
+    }.freeze
+
+    # Default Authorize endpoints
+    AUTHORIZATION_ENDPOINTS = {
+      production: 'https://account.viagogo.com/authorize'.freeze,
+      sandbox: 'https://sandbox.account.viagogo.com/authorize'.freeze
+    }.freeze
 
     class << self
       def client_id
@@ -20,13 +32,24 @@ module GogoKit
         ENV['GOGOKIT_ACCESS_TOKEN']
       end
 
+      def api_environment
+        env_api_environment = ENV['GOGOKIT_API_ENVIRONMENT']
+        env_api_environment.nil? ? :production : env_api_environment.to_sym
+      end
+
       def api_root_endpoint
-        ENV['GOGOKIT_API_ROOT_ENDPOINT'] || GogoKit::Default::API_ROOT_ENDPOINT
+        ENV['GOGOKIT_API_ROOT_ENDPOINT'] ||
+          GogoKit::Default::API_ROOT_ENDPOINTS[api_environment]
       end
 
       def oauth_token_endpoint
         ENV['GOGOKIT_OAUTH_TOKEN_ENDPOINT'] ||
-          GogoKit::Default::OAUTH_TOKEN_ENDPOINT
+          GogoKit::Default::OAUTH_TOKEN_ENDPOINTS[api_environment]
+      end
+
+      def authorization_endpoint
+        ENV['GOGOKIT_AUTHORIZATION_ENDPOINT'] ||
+          GogoKit::Default::AUTHORIZATION_ENDPOINTS[api_environment]
       end
     end
   end

data/lib/gogokit/middleware/raise_error.rb

@@ -13,7 +13,7 @@ module GogoKit
           if response_env[:status].to_i >= 400
             api_error = GogoKit::ApiError.new
             api_error.response = response_env
-            fail api_error, error_message(response_env)
+            raise api_error, error_message(response_env)
           end
         end
       end

data/lib/gogokit/version.rb

@@ -5,13 +5,13 @@ module GogoKit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 4
+  MINOR = 5
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 1
+  PATCH = 0
 
   # Full release version.
   # @return [String]
-  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gogokit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - viagogo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-09 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday