tankard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caf2e4adbd1c27dad9227737cec3b9ccb7947d4d
-  data.tar.gz: ce3dbc3b145c38afdcb37c80472ac042d121269d
+  metadata.gz: 6aa50daed58d6eec35118b8f2d8c3849ed224c01
+  data.tar.gz: f965bcf8557b59391b73d86fcaec0d9ed7c47113
 SHA512:
-  metadata.gz: 4734b1c05ec5529b9af9105c70308aacf74a5cdd04b76e570c461beb2775ff2a430ec1a3947f64b37d7a065bae75500e91b13e17d42aa233276080d4ff597b72
-  data.tar.gz: 1b27b4d244bb37e09453d9908d8fd91667244f47a5b22de60fe9f36ca89d68aa4128f127795574596811f960aa30740b23dae2b99aea8e7d40f4eb9c360a1575
+  metadata.gz: f8eb6fa746869c8e816f5e643b534dbbf411018825e566c5a0935360804fa763aa008cf0b96e2b84fa71cff92bb67da90221d06bee22ef2b134f9f790117ccd7
+  data.tar.gz: f0045e571b37fd5f651f5cb38ec598bd172b771844a20af09b74225ccf48f72748168823629fa9781854c9e1dddc3f802e3fa895d4d010af85d396817f77b74c

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'tankard.gemspec'
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+EmptyLinesAroundBody:
+  Enabled: false
+LineLength:
+  Enabled: false
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10

data/.travis.yml

@@ -1,15 +1,20 @@
 language: ruby
 rvm:
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.0.0
+  - rbx-2.1.1
+  - rbx-2.2.6
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.1.1
   - ruby-head
   - jruby-head
 jdk:
   - openjdk6
   - openjdk7
   - oraclejdk7
+  - oraclejdk8
 matrix:
   allow_failures:
     - rvm: ruby-head
@@ -19,15 +24,47 @@ matrix:
       jdk: openjdk7
     - rvm: 1.9.3
       jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk8
     - rvm: 2.0.0
       jdk: openjdk7
     - rvm: 2.0.0
       jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk8
+    - rvm: 2.1.0
+      jdk: openjdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk8
+    - rvm: 2.1.1
+      jdk: openjdk7
+    - rvm: 2.1.1
+      jdk: oraclejdk7
+    - rvm: 2.1.1
+      jdk: oraclejdk8
     - rvm: ruby-head
       jdk: openjdk7
     - rvm: ruby-head
       jdk: oraclejdk7
-    - rvm: rbx-19mode
+    - rvm: ruby-head
+      jdk: oraclejdk8
+    - rvm: rbx-2.0.0
+      jdk: openjdk7
+    - rvm: rbx-2.0.0
+      jdk: oraclejdk7
+    - rvm: rbx-2.0.0
+      jdk: oraclejdk8
+    - rvm: rbx-2.1.1
       jdk: openjdk7
-    - rvm: rbx-19mode
-      jdk: oraclejdk7
+    - rvm: rbx-2.1.1
+      jdk: oraclejdk7
+    - rvm: rbx-2.1.1
+      jdk: oraclejdk8
+    - rvm: rbx-2.2.6
+      jdk: openjdk7
+    - rvm: rbx-2.2.6
+      jdk: oraclejdk7
+    - rvm: rbx-2.2.6
+      jdk: oraclejdk8

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.2.0 (03/28/14)
+* Fixed Rspec deprecation's
+* Relaxed strictness of required gem's
+* Refactored a significant amount of the gem
+* Allow reusing of a query
+* Test gem against more ruby interpreters
+
 ## v0.1.0 (05/15/2013)
 * Add params method to beers.  Allows passing additional parameters in an additional way.
 * Add params method to beer.  Allows passing additional parameters in an additional way.
@@ -12,4 +19,4 @@
 
 ## v0.0.1
 * Support for querying a beer
-* Support for querying a list of beers
+* Support for querying a list of beers

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/lib/tankard.rb

@@ -1,9 +1,12 @@
-require "tankard/version"
-require "tankard/configuration"
-require "tankard/error"
-require "tankard/client"
-require "atomic"
+require 'tankard/version'
+require 'tankard/configuration'
+require 'tankard/error'
+require 'tankard/client'
+require 'atomic'
 
+# Sets up and delegates 'most' method calls to the Tankard Client
+#
+# @author Matthew Shafer
 module Tankard
   @client = ::Atomic.new
 
@@ -11,23 +14,23 @@ module Tankard
     include Configuration
 
     def client
-      @client.compare_and_swap(nil, Tankard::Client.new(credentials)) unless @client.value
+      @client.compare_and_swap(nil, Tankard::Client.new(credentials))
       @client.value
     end
 
     def respond_to?(method)
-      return client.respond_to?(method)
+      client.respond_to?(method)
     end
 
-    private
+  private
 
-      def method_missing(method_name, *args, &block)
-        return super unless client.respond_to?(method_name)
-        client.send(method_name, *args, &block)
-      end
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
 
-      def reset_client
-        @client.value = nil
-      end
+    def reset_client
+      @client.value = nil
+    end
   end
 end

data/lib/tankard/api/beer.rb

@@ -1,5 +1,4 @@
 require 'hashie'
-require 'tankard/api/request/get'
 require 'tankard/api/utils/page_finders'
 require 'tankard/api/utils/find'
 
@@ -10,7 +9,6 @@ module Tankard
     # @see http://www.brewerydb.com/developers/docs-endpoint/beer_index
     # @author Matthew Shafer
     class Beer
-      include Tankard::Api::Request::Get
       include Tankard::Api::Utils::PageFinders
       include Tankard::Api::Utils::Find
       # @!parse include ::Enumerable
@@ -20,9 +18,9 @@ module Tankard
       # @param request [Tankard::Request]
       # @param options [Hash]
       # @return [Tankard::Api::Beer]
-      def initialize(request, options={})
-        @request = request
-        @options = Hashie::Mash.new(options)
+      def initialize(request, options = {})
+        @http_client = request
+        @http_request_parameters = Hashie::Mash.new(options)
       end
 
       # @!method find(id_or_array, options={})
@@ -49,7 +47,7 @@ module Tankard
       # @param beer_id [String]
       # @return [self] returns itself
       def id(beer_id)
-        @options.id = beer_id
+        @http_request_parameters.id = beer_id
         self
       end
 
@@ -57,7 +55,7 @@ module Tankard
       #
       # @return [self] returns itself
       def breweries
-        @options.endpoint = "breweries"
+        @http_request_parameters.endpoint = 'breweries'
         self
       end
 
@@ -65,7 +63,7 @@ module Tankard
       #
       # @return [self] returns itself
       def events
-        @options.endpoint = "events"
+        @http_request_parameters.endpoint = 'events'
         self
       end
 
@@ -73,7 +71,7 @@ module Tankard
       #
       # @return [self] returns itself
       def ingredients
-        @options.endpoint = "ingredients"
+        @http_request_parameters.endpoint = 'ingredients'
         self
       end
 
@@ -81,7 +79,7 @@ module Tankard
       #
       # @return [self] returns itself
       def social_accounts
-        @options.endpoint = "socialaccounts"
+        @http_request_parameters.endpoint = 'socialaccounts'
         self
       end
 
@@ -89,7 +87,7 @@ module Tankard
       #
       # @return [self] returns itself
       def variations
-        @options.endpoint = "variations"
+        @http_request_parameters.endpoint = 'variations'
         self
       end
 
@@ -97,41 +95,34 @@ module Tankard
       #
       # @param options [Hash]
       # @return [self] returns itself
-      def params(options={})
-        options.each_pair do |key,value|
-          @options[key] = value
+      def params(options = {})
+        options.each_pair do |key, value|
+          @http_request_parameters[key] = value
         end
         self
       end
 
-      private
+    private
 
-        def http_request_uri
-          endpoint = "#{route}/#{raise_if_no_id_in_options}"
+      attr_reader :http_client
+      attr_reader :http_request_parameters
 
-          if @options.endpoint?
-            endpoint += "/#{@options.delete(:endpoint)}"
-          end
-
-          endpoint
-        end
-
-        def raise_if_no_id_in_options
-          raise Tankard::Error::MissingParameter, "No Beer ID is set" unless @options.id?
-          @options.delete(:id)
-        end
-
-        def route
-          "beer"
-        end
+      def http_request_uri
+        @request_endpoint = "/#{@http_request_parameters.delete(:endpoint)}" if @http_request_parameters.endpoint?
+        endpoint = "#{route}/#{raise_if_no_id_in_options}"
+        endpoint += @request_endpoint if @request_endpoint
+        endpoint
+      end
 
-        def http_client
-          @request
-        end
+      def raise_if_no_id_in_options
+        @beer_id = @http_request_parameters.delete(:id) if @http_request_parameters.id?
+        fail Tankard::Error::MissingParameter, 'No Beer ID is set' unless @beer_id
+        @beer_id
+      end
 
-        def http_request_parameters
-          @options
-        end
+      def route
+        'beer'
+      end
     end
   end
-end
+end

data/lib/tankard/api/beers.rb

@@ -18,9 +18,9 @@ module Tankard
       # @param request [Tankard::Request]
       # @param options [Hash]
       # @return [Tankard::Api::Beers]
-      def initialize(request, options={})
-        @request = request
-        @options = Hashie::Mash.new(options)
+      def initialize(request, options = {})
+        @http_client = request
+        @http_request_parameters = Hashie::Mash.new(options)
       end
 
       # @!method each(&block)
@@ -37,7 +37,7 @@ module Tankard
       # @param beer_name [String]
       # @return [self] returns itself
       def name(beer_name)
-        @options[:name] = beer_name
+        @http_request_parameters.name = beer_name
         self
       end
 
@@ -46,7 +46,7 @@ module Tankard
       # @param number [Integer]
       # @return [self] returns itself
       def page(number)
-        @options[:p] = number
+        @http_request_parameters.p = number
         self
       end
 
@@ -54,26 +54,21 @@ module Tankard
       #
       # @param options [Hash]
       # @return [self] returns itself
-      def params(options={})
-        options.each_pair do |key,value|
-          @options[key] = value
+      def params(options = {})
+        options.each_pair do |key, value|
+          @http_request_parameters[key] = value
         end
         self
       end
 
-      private
+    private
 
-        def http_request_uri
-          "beers"
-        end
-
-        def http_client
-          @request
-        end
+      attr_reader :http_client
+      attr_reader :http_request_parameters
 
-        def http_request_parameters
-          @options
-        end
+      def http_request_uri
+        'beers'
+      end
     end
   end
-end
+end

data/lib/tankard/api/request/get.rb

@@ -1,27 +1,23 @@
 module Tankard
   module Api
     module Request
+      # Helper for GET requests
+      #
+      # @author Matthew Shafer
       module Get
 
-        private
+      private
 
-          def request_data_with_nil_on_http_error(request_object, uri, options)
-            begin
-              request_data(request_object, uri, options)
-            rescue Tankard::Error::HttpError
-              nil
-            end
-          end
+        def request_data_with_nil_on_http_error(request_object, uri, options)
+          get_request(request_object, uri, options)['data']
+        rescue Tankard::Error::HttpError
+          nil
+        end
 
-          # break up the request methods into smaller pieces
-          def request_data(request_object, uri, options)
-            get_request(request_object, uri, options)["data"]
-          end
-
-          def get_request(request_object, uri, options)
-            request_object.get(uri, options)
-          end
+        def get_request(request_object, uri, options)
+          request_object.get(uri, options)
+        end
       end
     end
   end
-end
+end

data/lib/tankard/api/search.rb

@@ -17,9 +17,9 @@ module Tankard
       # @param request [Tankard::Request]
       # @param options [Hash]
       # @return [Tankard::Api::Search]
-      def initialize(request, options={})
-        @request = request
-        @options = Hashie::Mash.new(options)
+      def initialize(request, options = {})
+        @http_client = request
+        @http_request_parameters = Hashie::Mash.new(options)
       end
 
       # Calls the given block once for each result
@@ -40,7 +40,7 @@ module Tankard
       # @param search_query [String]
       # @return [self] returns itself
       def query(search_query)
-        @options.q = search_query
+        @http_request_parameters.q = search_query
         self
       end
 
@@ -49,7 +49,7 @@ module Tankard
       # @param number [Integer]
       # @return [self] returns itself
       def page(number)
-        @options.p = number
+        @http_request_parameters.p = number
         self
       end
 
@@ -57,9 +57,9 @@ module Tankard
       #
       # @param options [Hash]
       # @return [self] returns itself
-      def params(options={})
-        options.each_pair do |key,value|
-          @options[key] = value
+      def params(options = {})
+        options.each_pair do |key, value|
+          @http_request_parameters[key] = value
         end
         self
       end
@@ -69,7 +69,7 @@ module Tankard
       # @param search_type [String]
       # @return [self] returns itself
       def type(search_type)
-        @options.type = search_type
+        @http_request_parameters.type = search_type
         self
       end
 
@@ -79,8 +79,8 @@ module Tankard
       # @param upc_code [Integer]
       # @return [self] returns itself
       def upc(upc_code)
-        @options.code = upc_code
-        @options.endpoint = "upc"
+        @http_request_parameters.code = upc_code
+        @http_request_parameters.endpoint = 'upc'
         self
       end
 
@@ -91,42 +91,33 @@ module Tankard
       # @param longitude [Float]
       # @return [self] returns itself
       def geo_point(latitude, longitude)
-        @options.lat = latitude
-        @options.lng = longitude
-        @options.endpoint = "geo/point"
+        @http_request_parameters.lat = latitude
+        @http_request_parameters.lng = longitude
+        @http_request_parameters.endpoint = 'geo/point'
         self
       end
 
-      private
+    private
 
-        def http_request_uri
-          endpoint = "search"
+      attr_reader :http_client
+      attr_reader :http_request_parameters
 
-          if @options.endpoint?
-            endpoint += "/#{@options.delete(:endpoint)}"
-          end
-
-          endpoint
-        end
-
-        def http_client
-          @request
-        end
-
-        def http_request_parameters
-          @options
-        end
+      def http_request_uri
+        @request_endpoint = "/#{@http_request_parameters.delete(:endpoint)}" if @http_request_parameters.endpoint?
+        endpoint = 'search'
+        endpoint += @request_endpoint if @request_endpoint
+        endpoint
+      end
 
-        def raise_if_required_options_not_set
-          case @options.endpoint
-          when nil
-            raise Tankard::Error::MissingParameter, "No search query set" unless @options.q?
-          when "upc"
-            raise Tankard::Error::MissingParameter, "missing parameter: code" unless @options.code?
-          when "geo/point"
-            raise Tankard::Error::MissingParameter, "missing Parameters: lat, lng" unless @options.lat? && @options.lng?
-          end
+      def raise_if_required_options_not_set
+        if @http_request_parameters.endpoint.nil?
+          fail Tankard::Error::MissingParameter, 'No search query set' unless @http_request_parameters.q?
+        elsif @http_request_parameters.endpoint == 'upc'
+          fail Tankard::Error::MissingParameter, 'missing parameter: code' unless @http_request_parameters.code?
+        elsif @http_request_parameters.endpoint == 'geo/point'
+          fail Tankard::Error::MissingParameter, 'missing Parameters: lat, lng' unless @http_request_parameters.lat? && @http_request_parameters.lng?
         end
+      end
     end
   end
-end
+end