tankard 0.1.0 → 0.2.0

data/lib/tankard/api/style.rb

@@ -20,9 +20,9 @@ module Tankard
       # @param request [Tankard::Request]
       # @param options [Hash]
       # @return [Tankard::Api::Style]
-      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,32 +49,28 @@ module Tankard
       # @param style_id [String]
       # @return [self] returns itself
       def id(style_id)
-        @options.id = style_id
+        @http_request_parameters.id = style_id
         self
       end
 
-      private
+    private
 
-        def raise_if_no_id_in_options
-          raise Tankard::Error::MissingParameter, "No style id set" unless @options.id?
-          @options.delete(:id)
-        end
+      attr_reader :http_client
+      attr_reader :http_request_parameters
 
-        def route
-          "style"
-        end
-
-        def http_request_uri
-          "#{route}/#{raise_if_no_id_in_options}"
-        end
+      def raise_if_no_id_in_options
+        @style_id = @http_request_parameters.delete(:id) if @http_request_parameters.id?
+        fail Tankard::Error::MissingParameter, 'No style id set' unless @style_id
+        @style_id
+      end
 
-        def http_client
-          @request
-        end
+      def route
+        'style'
+      end
 
-        def http_request_parameters
-          @options
-        end
+      def http_request_uri
+        "#{route}/#{raise_if_no_id_in_options}"
+      end
     end
   end
-end
+end

data/lib/tankard/api/styles.rb

@@ -27,22 +27,20 @@ module Tankard
       # @param request [Tankard::Request]
       # @return [Tankard::Api::Styles]
       def initialize(request)
-        @request = request
+        @http_client = request
       end
 
-      private
+    private
 
-        def http_request_uri
-          "styles"
-        end
+      attr_reader :http_client
 
-        def http_client
-          @request
-        end
+      def http_request_uri
+        'styles'
+      end
 
-        def http_request_parameters
-          {}
-        end
+      def http_request_parameters
+        {}
+      end
     end
   end
-end
+end

data/lib/tankard/api/utils/find.rb

@@ -3,10 +3,13 @@ require 'tankard/api/request/get'
 module Tankard
   module Api
     module Utils
+      # Helper for finding one or more things by ID(s)
+      #
+      # @author Matthew Shafer
       module Find
         include Tankard::Api::Request::Get
 
-        def find(id_or_array, options={})
+        def find(id_or_array, options = {})
           options = http_request_parameters.merge!(options)
 
           if id_or_array.is_a?(Array)
@@ -16,20 +19,20 @@ module Tankard
           end
         end
 
-        private
+      private
 
-          def route
-            raise NoMethodError.new("Must implement and return the base route")
-          end
+        def route
+          fail NoMethodError, 'Must implement and return the base route'
+        end
 
-          def http_client
-            raise NoMethodError.new("Must return the http object to make requests with")
-          end
+        def http_client
+          fail NoMethodError, 'Must return the http object to make requests with'
+        end
 
-          def http_request_parameters
-            raise NoMethodError.new("Must return a hash like structure with request parameters")
-          end
+        def http_request_parameters
+          fail NoMethodError, 'Must return a hash like structure with request parameters'
+        end
       end
     end
   end
-end
+end

data/lib/tankard/api/utils/page_finders.rb

@@ -3,6 +3,10 @@ require 'tankard/api/request/get'
 module Tankard
   module Api
     module Utils
+      # Seamless querying of multiple pages of results
+      # Allows using any ruby enumerable (EX. map)
+      #
+      # @author Matthew Shafer
       module PageFinders
         include ::Enumerable
         include Tankard::Api::Request::Get
@@ -11,57 +15,58 @@ module Tankard
         #
         # @yieldparam [Hash] hash containing individual beer information
         def each(&block)
-          find_on_single_or_all_pages(http_request_uri, http_client, http_request_parameters, block)
+          find_on_single_or_all_pages(http_request_parameters, block)
         end
 
-        private
+      private
 
-          def find_on_single_or_all_pages(uri, request, options, block)
-            if options[:p]
-              find_on_single_page(uri, request, options, block)
-            else
-              find_on_all_pages(uri, request, options, block)
-            end
+        def find_on_single_or_all_pages(options, block)
+          if options[:p]
+            find_on_single_page(options, block)
+          else
+            find_on_all_pages(options, block)
           end
+        end
 
-          def find_on_all_pages(uri, request, options, block)
-            page = 0
+        def find_on_all_pages(options, block)
+          page = 0
 
-            begin
-              page += 1
-              options[:p] = page if page > 1
-              total_pages = find_on_single_page(uri, request, options, block)
-            end while page < total_pages
+          loop do
+            page += 1
+            options[:p] = page if page > 1
+            total_pages = find_on_single_page(options, block)
+            break unless page < total_pages
           end
+        end
 
-          def find_on_single_page(uri, request, options, block)
-            response = get_request(request, uri, options)
-            call_block_with_data(response["data"], block)
-            response["numberOfPages"].to_i
-          end
+        def find_on_single_page(options, block)
+          response = get_request(http_client, http_request_uri, options)
+          call_block_with_data(response['data'], block)
+          response['numberOfPages'].to_i
+        end
 
-          def call_block_with_data(data, block)
-            raise Tankard::Error::InvalidResponse unless data
+        def call_block_with_data(data, block)
+          fail Tankard::Error::InvalidResponse unless data
 
-            if data.is_a?(Hash)
-              block.call(data)
-            else
-              data.each { |item| block.call(item) }
-            end
+          if data.is_a?(Hash)
+            block.call(data)
+          else
+            data.each { |item| block.call(item) }
           end
+        end
 
-          def http_request_uri
-            raise NoMethodError.new("Need to implement method")
-          end
+        def http_request_uri
+          fail NoMethodError, 'Need to implement method'
+        end
 
-          def http_client
-            raise NoMethodError.new("Need to implement method")
-          end
+        def http_client
+          fail NoMethodError, 'Need to implement method'
+        end
 
-          def http_request_parameters
-            raise NoMethodError.new("Need to implement method")
-          end
+        def http_request_parameters
+          fail NoMethodError, 'Need to implement method'
+        end
       end
     end
   end
-end
+end

data/lib/tankard/client.rb

@@ -6,9 +6,13 @@ require 'tankard/api/styles'
 require 'tankard/api/style'
 
 module Tankard
+    # Interaction point for various endpoints
+    # When querying Tankard normally there is only one of these alive at a time
+    #
+    # @author Matthew Shafer
   class Client
 
-    def initialize(options={})
+    def initialize(options = {})
       Tankard::Configuration::KEYS.each do |key|
         instance_variable_set(:"@#{key}", options[key])
       end
@@ -16,15 +20,15 @@ module Tankard
       @tankard_request = Tankard::Request.new(@api_key)
     end
 
-    def beer(options={})
+    def beer(options = {})
       Tankard::Api::Beer.new(@tankard_request, options)
     end
 
-    def beers(options={})
+    def beers(options = {})
       Tankard::Api::Beers.new(@tankard_request, options)
     end
 
-    def search(options={})
+    def search(options = {})
       Tankard::Api::Search.new(@tankard_request, options)
     end
 
@@ -32,8 +36,8 @@ module Tankard
       Tankard::Api::Styles.new(@tankard_request)
     end
 
-    def style(options={})
+    def style(options = {})
       Tankard::Api::Style.new(@tankard_request, options)
     end
   end
-end
+end

data/lib/tankard/configuration.rb

@@ -1,9 +1,12 @@
 module Tankard
+  # Configuring and validating credentials
+  #
+  # @author Matthew Shafer
   module Configuration
     attr_writer :api_key
 
     KEYS = [:api_key]
-    BREWERYDB_URL = "http://api.brewerydb.com/v2/"
+    BREWERYDB_URL = 'http://api.brewerydb.com/v2/'
 
     def configure
       yield self
@@ -12,22 +15,22 @@ module Tankard
       self
     end
 
-    private
+  private
 
-      def credentials
-        {
-          api_key: @api_key
-        }
-      end
+    def credentials
+      {
+        api_key: @api_key
+      }
+    end
 
-      def validate_api_key!
-        unless @api_key.is_a?(String)
-          raise Tankard::Error::ConfigurationError, "api_key is not a string"
-        end
+    def validate_api_key!
+      unless @api_key.is_a?(String)
+        fail Tankard::Error::ConfigurationError, 'api_key is not a string'
       end
+    end
 
-      def reset_client
-        raise Tankard::Error::ConfigurationError, "Implement reset_client"
-      end
+    def reset_client
+      fail Tankard::Error::ConfigurationError, 'Implement reset_client'
+    end
   end
-end
+end

data/lib/tankard/error.rb

@@ -1,4 +1,7 @@
 module Tankard
+  # Custom errors classes
+  #
+  # @author Matthew Shafer
   module Error
     ConfigurationError = Class.new(::StandardError)
     MissingParameter = Class.new(::StandardError)
@@ -7,4 +10,4 @@ module Tankard
     InvalidResponse = Class.new(::StandardError)
     ApiKeyUnauthorized = Class.new(::StandardError)
   end
-end
+end

data/lib/tankard/request.rb

@@ -3,6 +3,9 @@ require 'httpclient'
 require 'tankard/error'
 
 module Tankard
+  # Handles making actual requests and checking them for any invalid status codes
+  #
+  # @author Matthew Shafer
   class Request
 
     def initialize(api_key)
@@ -10,36 +13,34 @@ module Tankard
       @api_key = api_key
     end
 
-    def get(route, params={})
+    def get(route, params = {})
       params[:key] = @api_key
       request = @http.get(build_request_url(route), params)
       raise_if_status_not_ok(request.status)
       load_json(request.body)
     end
 
-    private
+  private
 
-      def raise_if_status_not_ok(status)
-        case status
-        when 200
-          true
-        when 401
-          raise Tankard::Error::ApiKeyUnauthorized
-        else
-          raise Tankard::Error::HttpError
-        end
+    def raise_if_status_not_ok(status)
+      case status
+      when 200
+        true
+      when 401
+        fail Tankard::Error::ApiKeyUnauthorized
+      else
+        fail Tankard::Error::HttpError
       end
+    end
 
-      def build_request_url(route)
-        Tankard::Configuration::BREWERYDB_URL + route
-      end
+    def build_request_url(route)
+      Tankard::Configuration::BREWERYDB_URL + route
+    end
 
-      def load_json(json_data)
-        begin
-          MultiJson.load(json_data)
-        rescue MultiJson::LoadError
-          raise Tankard::Error::LoadError
-        end
-      end
+    def load_json(json_data)
+      MultiJson.load(json_data)
+    rescue MultiJson::LoadError
+      raise Tankard::Error::LoadError
+    end
   end
-end
+end

data/lib/tankard/version.rb

@@ -1,3 +1,6 @@
+# Current Version of the Gem
+#
+# @author Matthew Shafer
 module Tankard
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/spec/shared_examples_for_find.rb

@@ -1,30 +1,30 @@
-shared_examples "the find method" do
+shared_examples 'the find method' do
 
-   context "when looking up a valid item" do
+  context 'when looking up a valid item' do
 
-     it "returns data on the item" do
-       expect(context.find(valid_items.first)).to eql(valid_responses.first)
-     end
-   end
+    it 'returns data on the item' do
+      expect(context.find(valid_items.first)).to eql(valid_responses.first)
+    end
+  end
 
-   context "when looking up an invalid item" do
+  context 'when looking up an invalid item' do
 
-     it "returns nil when not found" do
-       expect(context.find(invalid_items.first)).to eql(nil)
-     end
-   end
+    it 'returns nil when not found' do
+      expect(context.find(invalid_items.first)).to eql(nil)
+    end
+  end
 
-   context "when looking up multiple valid items" do
+  context 'when looking up multiple valid items' do
 
-     it "returns an array of data with each item" do
-       expect(context.find(valid_items)).to eql(valid_responses)
-     end
-   end
+    it 'returns an array of data with each item' do
+      expect(context.find(valid_items)).to eql(valid_responses)
+    end
+  end
 
-   context "when looking up multiple items and one is invalid" do
+  context 'when looking up multiple items and one is invalid' do
 
-     it "returns an array with only the valid items" do
-       expect(context.find(valid_invalid_items)).to eql(valid_responses)
-     end
-   end
-end
+    it 'returns an array with only the valid items' do
+      expect(context.find(valid_invalid_items)).to eql(valid_responses)
+    end
+  end
+end