brewery_db 0.0.1 → 0.1.0

data/lib/brewery_db/middleware/error_handler.rb

@@ -0,0 +1,28 @@
+module BreweryDB
+  module Middleware
+    class ErrorHandler < Faraday::Response::Middleware
+      def on_complete(env)
+        case env[:status]
+          when 200
+          when 400 then fail with(BadRequest, env)
+          when 401 then fail with(rate_limit_exceeded_or_unauthorized(env[:response_headers]), env)
+          when 404 then fail with(NotFound, env)
+          else fail with(Error, env)
+        end
+      end
+
+      def rate_limit_exceeded_or_unauthorized(headers)
+        rate_limit = headers.fetch('x-ratelimit-remaining') { :rate_limit_unknown }
+
+        rate_limit == '0' ? RateLimitExceeded : Unauthorized
+      end
+      private :rate_limit_exceeded_or_unauthorized
+
+      def with(error_class, env)
+        message = "Status => #{env[:status]}. Error message => #{env[:body].error_message}"
+        error_class.new(message)
+      end
+      private :with
+    end
+  end
+end

data/lib/brewery_db/request.rb

@@ -0,0 +1,27 @@
+module BreweryDB
+  class Request
+    def initialize(connection, path, params={})
+      @connection = connection
+      @path = path
+      @params = params
+    end
+
+    def response
+      Response.new(response_body, self)
+    end
+
+    def next_page
+      self.class.new(@connection, @path, @params.merge(p: page_number + 1))
+    end
+
+    def response_body
+      @connection.get(@path, @params).body
+    end
+    private :response_body
+
+    def page_number
+      @params[:p] || 1
+    end
+    private :page_number
+  end
+end

data/lib/brewery_db/resource.rb

@@ -3,34 +3,28 @@ require 'faraday_middleware'
 
 module BreweryDB
   class Resource
-    def initialize(client)
-      @client = client
-    end
-
-    # TODO: Make this private once the appropriate test coverage is in place.
-    def connection
-      # TODO: Use an instance-level option once faraday_middleware is updated.
-      FaradayMiddleware::Mashify.mash_class = Response
-
-      Faraday.new(
-        url: @client.config.endpoint,
-        headers: { user_agent: @client.config.user_agent }
-      ) do |connection|
-        connection.response(:mashify)
-        connection.response(:json, content_type: /\bjson$/)
-
-        connection.adapter(@client.config.adapter)
-      end
+    def initialize(config)
+      @config = config
     end
 
     def get(path, params={})
-      connection.get(path, default_params.merge(params)).body
+      Request.new(connection, path, params).response
     end
     private :get
 
-    def default_params
-      { key: @client.config.api_key }
+    def connection
+      Faraday.new(request: { timeout: @config.timeout }) do |builder|
+        builder.url_prefix = @config.base_uri
+        builder.headers[:user_agent] = @config.user_agent
+        builder.params[:key] = @config.api_key
+
+        builder.use(Middleware::ErrorHandler)
+        builder.response(:mashify, mash_class: Mash)
+        builder.response(:json, content_type: /\bjson$/)
+
+        builder.adapter(@config.adapter)
+      end
     end
-    private :default_params
+    private :connection
   end
 end

data/lib/brewery_db/resources/beers.rb

@@ -2,11 +2,11 @@ module BreweryDB
   module Resources
     class Beers < Resource
       def all(params={})
-        get('beers', params)
+        get('beers', params).collection
       end
 
       def find(id, params={})
-        get('beer/%s' % id, params)
+        get('beer/%s' % id, params).data
       end
     end
   end

data/lib/brewery_db/resources/breweries.rb

@@ -2,11 +2,11 @@ module BreweryDB
   module Resources
     class Breweries < Resource
       def all(params={})
-        get('breweries', params)
+        get('breweries', params).collection
       end
 
       def find(id, params={})
-        get('brewery/%s' % id, params)
+        get('brewery/%s' % id, params).data
       end
     end
   end

data/lib/brewery_db/resources/brewery.rb

@@ -0,0 +1,16 @@
+module BreweryDB
+  module Resources
+    class Brewery < Resource
+      attr_reader :id
+
+      def initialize(config, options={})
+        @id = options[:id]
+        super(config)
+      end
+
+      def beers(params={})
+        get("brewery/#{id}/beers", params).data
+      end
+    end
+  end
+end

data/lib/brewery_db/resources/categories.rb

@@ -2,11 +2,11 @@ module BreweryDB
   module Resources
     class Categories < Resource
       def all(params={})
-        get('categories', params)
+        get('categories', params).data
       end
 
       def find(id, params={})
-        get('category/%s' % id, params)
+        get('category/%s' % id, params).data
       end
     end
   end

data/lib/brewery_db/resources/glassware.rb

@@ -2,11 +2,11 @@ module BreweryDB
   module Resources
     class Glassware < Resource
       def all(params={})
-        get('glassware', params)
+        get('glassware', params).data
       end
 
       def find(id, params={})
-        get('glass/%s' % id, params)
+        get('glass/%s' % id, params).data
       end
     end
   end

data/lib/brewery_db/resources/search.rb

@@ -2,7 +2,7 @@ module BreweryDB
   module Resources
     class Search < Resource
       def all(params={})
-        get('search', params)
+        get('search', params).collection
       end
 
       def beers(params={})

data/lib/brewery_db/resources/styles.rb

@@ -2,11 +2,11 @@ module BreweryDB
   module Resources
     class Styles < Resource
       def all(params={})
-        get('styles', params)
+        get('styles', params).data
       end
 
       def find(id, params={})
-        get('style/%s' % id, params)
+        get('style/%s' % id, params).data
       end
     end
   end

data/lib/brewery_db/response.rb

@@ -1,18 +1,32 @@
-require 'hashie'
-
 module BreweryDB
-  class Response < Hashie::Mash
-    def convert_key(key)
-      key = key.to_s.dup
-      key.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      key.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      key.tr('-', '_').downcase
+  class Response
+    def initialize(body, request)
+      @body = body
+      @request = request
+    end
+
+    def data
+      @body.data
+    end
+
+    def collection
+      Collection.new(self)
+    end
+
+    def next_page
+      @request.next_page.response
+    end
+
+    def page_number
+      @body.current_page
+    end
+
+    def page_count
+      @body.number_of_pages
     end
-    protected :convert_key
 
-    def convert_value(value, duping=false)
-      value.is_a?(String) ? super.gsub("\r\n", "\n") : super
+    def count
+      @body.total_results
     end
-    protected :convert_value
   end
 end

data/lib/brewery_db/version.rb

@@ -1,3 +1,3 @@
 module BreweryDB
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/brewery_db/web_hook.rb

@@ -0,0 +1,32 @@
+require 'digest/sha1'
+
+module BreweryDB
+  class WebHook
+    attr_reader :action
+    attr_reader :attribute
+    attr_reader :attribute_id
+    attr_reader :key
+    attr_reader :nonce
+    attr_reader :sub_action
+    attr_reader :timestamp
+
+    def initialize(args)
+      @action = args[:action]
+      @attribute = args[:attribute]
+      @attribute_id = args[:attributeId]
+      @key = args[:key]
+      @nonce = args[:nonce]
+      @sub_action = args[:subAction]
+      @timestamp = args[:timestamp]
+    end
+
+    def valid?(api_key)
+      hash(api_key) == key
+    end
+
+    def hash(api_key)
+      Digest::SHA1.hexdigest("#{api_key}#{nonce}")
+    end
+    private :hash
+  end
+end

data/spec/brewery_db/client_spec.rb

@@ -2,43 +2,54 @@ require 'spec_helper'
 
 describe BreweryDB::Client do
   context '#config' do
-    subject { described_class.new.config }
-
-    it { should be_a(BreweryDB::Config) }
+    it 'returns a configuration instance' do
+      subject.config.should be_a(BreweryDB::Config)
+    end
 
-    its(:adapter) { should == BreweryDB::Config::ADAPTER }
-    its(:api_key) { should == nil }
-    its(:endpoint) { should == BreweryDB::Config::ENDPOINT }
+    it 'memoizes the return value' do
+      BreweryDB::Config.should_receive(:new).once.and_return(stub)
+      2.times { subject.config }
+    end
   end
 
   context '#configure' do
-    subject do
-      described_class.new.configure do |config|
-        config.adapter = :typhoeus
-        config.api_key = 'A1029384756B'
-        config.endpoint = 'http://api.playground.brewerydb.com'
-      end
+    it 'can set the adapter' do
+      expect {
+        subject.configure { |config| config.adapter = :typhoeus }
+      }.to change(subject.config, :adapter).to(:typhoeus)
     end
 
-    its(:adapter) { should == :typhoeus }
-    its(:api_key) { should == 'A1029384756B' }
-    its(:endpoint) { should == 'http://api.playground.brewerydb.com' }
-  end
+    it 'can set the API key' do
+      expect {
+        subject.configure { |config| config.api_key = 'secret' }
+      }.to change(subject.config, :api_key).to('secret')
+    end
 
-  {
-    beers: BreweryDB::Resources::Beers,
-    breweries: BreweryDB::Resources::Breweries,
-    categories: BreweryDB::Resources::Categories,
-    glassware: BreweryDB::Resources::Glassware,
-    search: BreweryDB::Resources::Search,
-    styles: BreweryDB::Resources::Styles
-  }.each do |method, resource|
-    context "##{method}" do
-      specify do
-        endpoint = resource.new(subject)
-        resource.should_receive(:new).and_return(endpoint)
-        subject.send(method).should == endpoint
-      end
+    it 'can set the base URI' do
+      expect {
+        subject.configure { |config| config.base_uri = 'http://example.com' }
+      }.to change(subject.config, :base_uri).to('http://example.com')
+    end
+
+    it 'can set the timeout' do
+      expect {
+        subject.configure { |config| config.timeout = 42 }
+      }.to change(subject.config, :timeout).to(42)
+    end
+
+    it 'can set the user agent' do
+      expect {
+        subject.configure { |config| config.user_agent = 'Brewdega' }
+      }.to change(subject.config, :user_agent).to('Brewdega')
     end
   end
+
+  its(:beers) { should be_a(BreweryDB::Resources::Beers) }
+  its(:breweries) { should be_a(BreweryDB::Resources::Breweries) }
+  its(:categories) { should be_a(BreweryDB::Resources::Categories) }
+  its(:glassware) { should be_a(BreweryDB::Resources::Glassware) }
+  its(:search) { should be_a(BreweryDB::Resources::Search) }
+  its(:styles) { should be_a(BreweryDB::Resources::Styles) }
+
+  it { subject.brewery('KlSsWY').should be_a(BreweryDB::Resources::Brewery) }
 end

data/spec/brewery_db/config_spec.rb

@@ -1,27 +1,16 @@
 require 'spec_helper'
 
 describe BreweryDB::Config do
-  {
-    ADAPTER: Faraday.default_adapter,
-    ENDPOINT: 'http://api.brewerydb.com/v2',
-    USER_AGENT: "BreweryDB Ruby Gem #{BreweryDB::VERSION}"
-  }.each do |constant, value|
-    context constant do
-      subject { described_class.const_get(constant) }
-
-      it { should == value }
-    end
-  end
-
   context 'defaults' do
-    its(:adapter) { should == described_class::ADAPTER }
-    its(:api_key) { should == nil }
-    its(:endpoint) { should == described_class::ENDPOINT }
-    its(:user_agent) { should == described_class::USER_AGENT }
+    its(:adapter) { should eq Faraday.default_adapter }
+    its(:api_key) { should be_nil }
+    its(:base_uri) { should eq described_class::BASE_URI }
+    its(:timeout) { should eq described_class::TIMEOUT }
+    its(:user_agent) { should eq described_class::USER_AGENT }
   end
 
   context '#adapter=' do
-    specify do
+    it do
       expect {
         subject.adapter = :typhoeus
       }.to change(subject, :adapter).to(:typhoeus)
@@ -29,26 +18,34 @@ describe BreweryDB::Config do
   end
 
   context '#api_key=' do
-    specify do
+    it do
+      expect {
+        subject.api_key = 'secret'
+      }.to change(subject, :api_key).to('secret')
+    end
+  end
+
+  context '#base_uri=' do
+    it do
       expect {
-        subject.api_key = 'A1029384756B'
-      }.to change(subject, :api_key).to('A1029384756B')
+        subject.base_uri = 'http://example.com'
+      }.to change(subject, :base_uri).to('http://example.com')
     end
   end
 
-  context '#endpoint=' do
-    specify do
+  context 'timeout=' do
+    it do
       expect {
-        subject.endpoint = 'http://api.playground.brewerydb.com'
-      }.to change(subject, :endpoint).to('http://api.playground.brewerydb.com')
+        subject.timeout = 42
+      }.to change(subject, :timeout).to(42)
     end
   end
 
-  context '#user_agent=' do
-    specify do
+  context 'user_agent=' do
+    it do
       expect {
-        subject.user_agent = 'A BreweryDB Application'
-      }.to change(subject, :user_agent).to('A BreweryDB Application')
+        subject.user_agent = 'Brewdega'
+      }.to change(subject, :user_agent).to('Brewdega')
     end
   end
 end