gogokit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWVkMTVkMmRmMzc0ZTYzNTVjYTg2ZDVhZWNlYzMzMjVkZjk2MDZmMw==
+    OWQzMmUzYzU1MDVmZGUxY2M4ZjI1Njk4MDE2MWM5MzIwZDYyZGM2NA==
   data.tar.gz: !binary |-
-    ZTQyNjU2M2Q5NzJhOGUyYjAyZTdjNWM2NjY1MzgzYTQ1YWUzYWM3Nw==
+    MDMxOTMzZWFhYTcwMmViYmIxZTNmMTQ0MGY0MWU0MTFkMWQ5ZWRlYw==
 SHA512:
   metadata.gz: !binary |-
-    MjgxZGFjZjhiMGQ4OTFiMThlYWUyNTM0N2JjNDkyZDhhYjkxZWUyYzIwM2U3
-    NmI3Y2Q3NDFhOGQwNzE4ZTJiMWRmNGI4MDg2NDM2NzZjYzdmMTQ3ZTcxMmM0
-    M2ExNmVkMDlhNTQxZGEyNjg4ZTZkMWQ5ZDA5Y2NkOTczZWIzYzA=
+    M2RlN2YzMDk2NzdmNDdlMzczYzJlMzkzYzI3MDA2NTliMzQ2YjJmNDMxMTlm
+    OGVhMTJjNGMyNWVlOGUwZDRlYTUzZjVhMzA0MjJhMWJjNDBiNDkyNGI3ZDZm
+    ODRlMGU5ZmFjMjU1NTcwM2I2MWExODc1Yzk5ZDA3OTBiNDM5YmQ=
   data.tar.gz: !binary |-
-    NzZmZGUyYjY0YjAwMTQ3NmU0MzMyMzliNTU4YTBhOTAyZGU4MmI3MTE0NGIw
-    OTljMjk3MzkzZjkxYzUyZDM4NGE1ODhhMDkzNTA3YmRjNGE5ZmU1Y2FiYmFl
-    ODQ1Yzc0M2IwNGQ0ODcyN2YyYWY5YTNkNTVhMDQ1OTY2ZGIyZDk=
+    YzVjM2UzNWM4MWRmNWIyOGVlZGQ5YTZmYzFmYjcyNTAzMWY1YjExNzZlYjhm
+    ZmMxNjVhOTcyYzdkNzFiMjhhOTU0MTNiOWFlY2U4MjNlNGEwMjk5YmNlMTJh
+    NmE4NzMzOTJmMjlkMzE1N2M5Y2YyNzYxNTIxNjQ4MTJmZDcxMzk=

data/README.md

@@ -32,7 +32,7 @@ Install via Ruby gems
 
 ... or add to your Gemfile
 
-    gem 'gogokit', '~> 0.2'
+    gem 'gogokit', '~> 0.3'
 
 
 ## Usage
@@ -62,6 +62,46 @@ genres = client.get_genres
 ```
 
 
+## Configuration and defaults
+
+GogoKit::Client accepts a range of options when creating a new client instance.
+
+### Configuring client instances
+
+Every writeable attribute in {GogoKit::Configuration} can be set one at a time
+
+```ruby
+client = GogoKit::Client.new
+client.client_id = YOUR_CLIENT_ID
+client.api_root_endpoint = 'https://sandbox.api.viagogo.net'
+```
+
+or in a block:
+
+```ruby
+client = GogoKit::Client.new do |config|
+  config.client_id = YOUR_CLIENT_ID
+  config.api_root_endpoint = 'https://sandbox.api.viagogo.net'
+end
+```
+
+### Using ENV variables
+
+Default configuration values are specified in {GogoKit::Default}. Many
+attributes will look for a default value from the ENV before returning GogoKit's
+default.
+
+```ruby
+# Given $GOGOKIT_CLIENT_ID is "abcd1234" and $GOGOKIT_API_ROOT_ENDPOINT is
+# "http://sandbox.api.viagogo.net"
+client = GogoKit::Client.new
+client.client_id
+client.api_root_endpoint
+
+# => "abcd1234"
+# => "http://sandbox.api.viagogo.net"
+```
+
 ## How to contribute
 
 All submissions are welcome. Fork the repository, read the rest of this README
@@ -118,4 +158,4 @@ introduced with new major versions. As a result of this policy, you can (and
 should) specify a dependency on this gem using the [Pessimistic Version
 Constraint][pvc] with two digits of precision. For example:
 
-    spec.add_dependency 'gogokit', '~> 0.1'
+    spec.add_dependency 'gogokit', '~> 0.3'

data/lib/gogokit/client.rb

@@ -43,28 +43,28 @@ module GogoKit
     include GogoKit::Client::User
     include GogoKit::Client::Venue
 
-    attr_accessor :client_id,
-                  :client_secret,
-                  :access_token
-
     # Initializes a new {GogoKit::Client}
     #
     # @param options [Hash]
     # @option options [String] :client_id Client Id of your application
     # @option options [String] :client_secret Client Secret of your application
+    # @option options [String] :api_root_endpoint Endpoint where the API root
+    # is located
     # @option options [String] :oauth_token_endpoint Endpoint for obtaining
     # OAuth access tokens
     # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
     # client credentials are not a String or Symbol.
     # @return [GogoKit::Client]
     def initialize(options = {})
+      reset!
+
       options.each do |key, value|
         send(:"#{key}=", value)
       end
       yield self if block_given?
 
-      validate_credential_type!
-      validate_configuration!
+      validate_configuration_credentials!
+      validate_configuration_endpoints!
     end
 
     # The User-Agent header used when making HTTP requests
@@ -152,28 +152,5 @@ module GogoKit
       # Add an Authorization header since we don't have one yet
       options[:headers]['Authorization'] = "Bearer #{access_token}"
     end
-
-    # @return [Hash]
-    def credentials
-      {
-        client_id: client_id,
-        client_secret: client_secret,
-        access_token: access_token
-      }
-    end
-
-    # Ensures that all credentials set during configuration are of a valid type.
-    # Valid types are String and Symbol.
-    #
-    # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
-    # credentials are not a String or Symbol.
-    def validate_credential_type!
-      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.')
-      end
-    end
   end
 end

data/lib/gogokit/configuration.rb

@@ -5,20 +5,40 @@ module GogoKit
   # Configuration options for {GogoKit::Client} or falls back to
   # {GogoKit::Default}
   module Configuration
-    attr_writer :api_root_endpoint,
-                :oauth_token_endpoint
+    attr_accessor :client_id,
+                  :client_secret,
+                  :access_token,
+                  :api_root_endpoint,
+                  :oauth_token_endpoint
 
-    # The endpoint for the API root resource
-    def api_root_endpoint
-      @api_root_endpoint || GogoKit::Default::API_ROOT_ENDPOINT
+    # Reset configuration options to default values
+    def reset!
+      keys.each do |key|
+        instance_variable_set(:"@#{key}", GogoKit::Default.send(key))
+      end
+      self
     end
 
-    # The endpoint for obtaining OAuth access tokens
-    def oauth_token_endpoint
-      @oauth_token_endpoint || GogoKit::Default::OAUTH_TOKEN_ENDPOINT
+    private
+
+    def keys
+      @keys ||= [
+        :client_id,
+        :client_secret,
+        :access_token,
+        :api_root_endpoint,
+        :oauth_token_endpoint
+      ]
     end
 
-    private
+    # @return [Hash]
+    def credentials
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token
+      }
+    end
 
     def endpoints
       {
@@ -27,7 +47,21 @@ module GogoKit
       }
     end
 
-    def validate_configuration!
+    # Ensures that all credentials set during configuration are of a valid type.
+    # Valid types are String and Symbol.
+    #
+    # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
+    # credentials are not a String or Symbol.
+    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.')
+      end
+    end
+
+    def validate_configuration_endpoints!
       endpoints.each do |endpoint, value|
         next if !value.nil? && value =~ /\A#{URI.regexp}\z/
 

data/lib/gogokit/default.rb

@@ -6,5 +6,28 @@ module GogoKit
 
     # Default OAuth token endpoint
     OAUTH_TOKEN_ENDPOINT = 'https://www.viagogo.com/secure/oauth2/token'.freeze
+
+    class << self
+      def client_id
+        ENV['GOGOKIT_CLIENT_ID']
+      end
+
+      def client_secret
+        ENV['GOGOKIT_CLIENT_SECRET']
+      end
+
+      def access_token
+        ENV['GOGOKIT_ACCESS_TOKEN']
+      end
+
+      def api_root_endpoint
+        ENV['GOGOKIT_API_ROOT_ENDPOINT'] || GogoKit::Default::API_ROOT_ENDPOINT
+      end
+
+      def oauth_token_endpoint
+        ENV['GOGOKIT_OAUTH_TOKEN_ENDPOINT'] ||
+          GogoKit::Default::OAUTH_TOKEN_ENDPOINT
+      end
+    end
   end
 end

data/lib/gogokit/version.rb

@@ -5,7 +5,7 @@ module GogoKit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 2
+  MINOR = 3
 
   # Current patch level.
   # @return [Integer]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gogokit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - viagogo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday