brewery_db 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjQzMTM3ZWNlM2JhODRkM2FkMDU2MDAzOWVkNzUwOGFkOWU1OTY5OA==
+  data.tar.gz: !binary |-
+    ZGM5NmZmMmE1MDcyYWUyMjFkODZkMmFlYjNiNjI5NTM0Y2JkMGUyZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGIxYmNhNjNlMWZiNGZhYzE0MzdjYjM4MzQ5YmYzMTUwNDRiOWM2YzczNDdl
+    ZDRkZjQzNmNjOThjNGY5YzkzZmNmMzRjYzViMTAzZWJiNWY1Yzk3ZDA2M2Ey
+    OTQwNjkyNTkzMjE0YTY3MzE1ZjA3OWZhYjRiYjlmMDg3NGQzZDY=
+  data.tar.gz: !binary |-
+    NjBiYjUxZGRmNTdmMjEyYTNjY2U0ZmMzYjQ5YTUxNjEyMThiNDAwNTBhMjY4
+    YjQzOGJhZWJlMmM4YWY4NzdiZDE4ZmI5ZGMxMWJlM2ZmZjY4OTAzMWFmMTdj
+    MzI2NGY4ZTNjYTYwMDcyZGJjYTljYmQ3NGU2NTA2MTNhMzJiYjg=

data/.gitignore

@@ -3,6 +3,7 @@
 *.swp
 .bundle
 .config
+.rbenv-version
 .rvmrc
 .yardoc
 Gemfile.lock
@@ -15,6 +16,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+tags
 test/tmp
 test/version_tmp
 tmp

data/.rspec

@@ -1,2 +1,4 @@
 --color
 --format progress
+
+-r pry

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## BreweryDB 0.0.2 (Unreleased)
+
+  * Raise exceptions on unsuccessful responses
+  * Return the data directly on successful responses ([Steven Harman][stevenharman])
+  * Add support for `brewery/:id/beers` endpoint ([Steven Harman][stevenharman])
+  * Require `faraday_middleare` ~> 0.8 ([Steven Harman][stevenharman])
+  * Add support for handling webhook parameters ([Steven Harman][stevenharman])
+
+## BreweryDB 0.0.1
+
+  * Initial release
+
+[stevenharman]: http://github.com/stevenharman

data/README.md

@@ -1,6 +1,11 @@
 # BreweryDB
 
-A Ruby library for interfacing with the [BreweryDB][] API.
+[![Build Status][travis]][travis-web]
+
+[travis]: https://secure.travis-ci.org/tylerhunt/brewery_db.png
+[travis-web]: http://travis-ci.org/tylerhunt/brewery_db
+
+A Ruby library for using the [BreweryDB][] API.
 
 [brewerydb]: http://www.brewerydb.com/
 
@@ -29,55 +34,94 @@ one, you may [request one here][api-key].
 
 [api-key]: http://www.brewerydb.com/developers
 
-Use the following method to configure your API key:
+You can use the following method to configure your API key:
 
 ``` ruby
-BreweryDB.configure do |config|
+brewery_db = BreweryDB::Client.new do |config|
   config.api_key = API_KEY
 end
 ```
 
-If you'd like to use multiple instance of the API with different keys, you may
-instantiate the `BreweryDB::Client` directly and treat those instances the same
-as the `BreweryDB` module:
+
+## Usage
+
+Once an API key has been set, resources can be called on the client instance.
 
 ``` ruby
-brewery_db = BreweryDB::Client.new
+brewery_db.beers.all(abv: '5.5')
+brewery_db.beers.find('vYlBZQ')
 
-brewery_db.configure do |config|
-  config.api_key = API_KEY
-end
+brewery_db.breweries.all(established: 2006)
+brewery_db.breweries.find('d1zSa7')
+
+brewery_db.brewery('d1zSa7').beers
+
+brewery_db.categories.all
+brewery_db.categories.find(1)
+
+brewery_db.glassware.all
+brewery_db.glassware.find(1)
+
+brewery_db.search.all(q: 'IPA')
+brewery_db.search.beers(q: 'IPA')
+brewery_db.search.breweries(q: 'IPA')
+brewery_db.search.guilds(q: 'IPA')
+brewery_db.search.events(q: 'IPA')
+
+brewery_db.styles.all
+brewery_db.styles.find(1)
 ```
 
+### WebHooks
 
-## Usage
+The BreweryDB API also provides [WebHooks][webhooks] which can be use to:
 
-Once the API key has been configured, resources may be called off the module
-directly or off your client instances:
+> keep your local data stores in sync with the main BreweryDB API.  Instead of
+> having to constantly query the API, webhooks will send you a message when
+> something changes.
 
-``` ruby
-BreweryDB.beers.all(abv: '5.5')
-BreweryDB.beers.find('vYlBZQ')
+This library provides a simple abstraction over the data posted by those
+webhooks.
+
+```ruby
+webhook = BreweryDB::WebHook.new(webhook_params_hash)
+```
+
+#### Validating a WebHook
+
+The `webhook_params_hash` should contain the `key`, `nonce`, `action`, etc.
+sent as the payload of the webhook. A `BreweryDB::WebHook` object can validate
+the posted data by SHA1 hashing your API key with the `nonce` value and
+comparing it to the `key` value (as per the [docs][webhooks]).
+
+```ruby
+webhook.valid?(API_KEY) #=> true or false
+```
 
-BreweryDB.breweries.all(established: 2006)
-BreweryDB.breweries.find('d1zSa7')
+#### Idiomatic wrapper over WebHook parameters
 
-BreweryDB.categories.all
-BreweryDB.categories.find(1)
+The `BreweryDB::WebHook` object also provides an idiomatic Ruby wrapper over
+the parameters. For example, one of the parameters posted in a webhook is
+`attributeId`, which is the BreweryDB id for a brewery, beer, etc. This
+parameter is exposed by an instance of `BreweryDB::WebHook` via
 
-BreweryDB.glassware.all
-BreweryDB.glassware.find(1)
+```ruby
+webhook.attribute_id #=> 'x6bRxw'
+```
 
-BreweryDB.search.all(q: 'IPA')
-BreweryDB.search.beers(q: 'IPA')
-BreweryDB.search.breweries(q: 'IPA')
-BreweryDB.search.guilds(q: 'IPA')
-BreweryDB.search.events(q: 'IPA')
+The full list of parameters available are:
 
-BreweryDB.styles.all
-BreweryDB.styles.find(1)
+```ruby
+webhook.action #=> 'insert'
+webhook.attribute #=> 'beer'
+webhook.attribute_id #=> 'x6bRxw'
+webhook.key #=> 'some-long-key-value-here'
+webhook.nonce #=> 'some-long-nonce-value-here'
+webhook.sub_action #=> 'none'
+webhook.timestamp #=> '1350573527'
 ```
 
+[webhooks]: http://developer.pintlabs.com/brewerydb/webhooks/
 
 ## Contributing
 
@@ -88,6 +132,14 @@ BreweryDB.styles.find(1)
 5. Create a new Pull Request.
 
 
+## Contributors
+
+Thanks to the following people who have contributed patches or helpful
+suggestions:
+
+  * [Steven Harman](https://github.com/stevenharman)
+
+
 ## Copyright
 
 Copyright © 2012 Tyler Hunt. See LICENSE for details.

data/Rakefile

@@ -1,3 +1,8 @@
 #!/usr/bin/env rake
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/brewery_db.gemspec

@@ -3,16 +3,17 @@ require './lib/brewery_db/version'
 Gem::Specification.new do |gem|
   gem.name = 'brewery_db'
   gem.version = BreweryDB::VERSION
-  gem.summary = 'A Ruby library for interfacing with the BreweryDB API.'
+  gem.summary = 'A Ruby library for using the BreweryDB API.'
   gem.homepage = 'http://github.com/tylerhunt/brewery_db'
-  gem.author = 'Tyler Hunt'
+  gem.authors = ['Tyler Hunt', 'Steven Harman']
 
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency 'faraday', '~> 0.8.0'
-  gem.add_dependency 'faraday_middleware'
-  gem.add_dependency 'hashie', '~> 1.1'
-  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
+  gem.add_dependency 'hashie', '>= 1.1', '< 3'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec', '~> 2.11'
   gem.add_development_dependency 'vcr', '~> 2.0'
 
   gem.files = `git ls-files`.split($\)

data/lib/brewery_db.rb

@@ -1,36 +1,32 @@
 require 'brewery_db/version'
 
 module BreweryDB
+  Error = Class.new(StandardError)
+  BadRequest = Class.new(Error)
+  NotFound = Class.new(Error)
+  RateLimitExceeded = Class.new(Error)
+  Unauthorized = Class.new(Error)
+
   autoload :Client, 'brewery_db/client'
+  autoload :Collection, 'brewery_db/collection'
   autoload :Config, 'brewery_db/config'
+  autoload :Mash, 'brewery_db/mash'
+  autoload :Request, 'brewery_db/request'
   autoload :Resource, 'brewery_db/resource'
   autoload :Response, 'brewery_db/response'
+  autoload :WebHook, 'brewery_db/web_hook'
+
+  module Middleware
+    autoload :ErrorHandler, 'brewery_db/middleware/error_handler'
+  end
 
   module Resources
     autoload :Beers, 'brewery_db/resources/beers'
     autoload :Breweries, 'brewery_db/resources/breweries'
+    autoload :Brewery, 'brewery_db/resources/brewery'
     autoload :Categories, 'brewery_db/resources/categories'
     autoload :Glassware, 'brewery_db/resources/glassware'
     autoload :Search, 'brewery_db/resources/search'
     autoload :Styles, 'brewery_db/resources/styles'
   end
-
-  extend self
-
-  def respond_to?(method, include_private=false)
-    super || client.respond_to?(method, include_private)
-  end
-
-  def method_missing(method, *args, &block)
-    if client.respond_to?(method)
-      client.send(method, *args, &block)
-    else
-      super
-    end
-  end
-
-  def client
-    @client ||= Client.new
-  end
-  private :client
 end

data/lib/brewery_db/client.rb

@@ -1,36 +1,48 @@
 module BreweryDB
   class Client
+    def initialize(&block)
+      configure(&block) if block_given?
+    end
+
     def config
       @config ||= Config.new
     end
 
     def configure
       yield(config)
-      config
+      self
     end
 
     def beers
-      @beers ||= Resources::Beers.new(self)
+      @beers ||= Resources::Beers.new(config)
+    end
+
+    # Builds a new instance of the brewery resource.
+    #
+    # @param id [String] the brewery ID
+    # @return <Resources::Breweries> an instance of the brewery resource
+    def brewery(id)
+      Resources::Brewery.new(config, id: id)
     end
 
     def breweries
-      @breweries ||= Resources::Breweries.new(self)
+      @breweries ||= Resources::Breweries.new(config)
     end
 
     def categories
-      @categories ||= Resources::Categories.new(self)
+      @categories ||= Resources::Categories.new(config)
     end
 
     def glassware
-      @glassware ||= Resources::Glassware.new(self)
+      @glassware ||= Resources::Glassware.new(config)
     end
 
     def search
-      @search ||= Resources::Search.new(self)
+      @search ||= Resources::Search.new(config)
     end
 
     def styles
-      @styles ||= Resources::Styles.new(self)
+      @styles ||= Resources::Styles.new(config)
     end
   end
 end

data/lib/brewery_db/collection.rb

@@ -0,0 +1,42 @@
+module BreweryDB
+  class Collection
+    include Enumerable
+
+    BATCH_SIZE = 50
+
+    attr_reader :size
+    alias length size
+
+    def initialize(response)
+      self.response = response
+    end
+
+    def count(*args, &block)
+      # The Ruby documentation is wrong, and Enumerable#count no longer calls
+      # #size, so let's make sure it's used here when no arguments are given.
+      if args.empty? && !block_given?
+        size
+      else
+        super
+      end
+    end
+
+    def each
+      return to_enum unless block_given?
+
+      while @collection.any?
+        @collection.each { |element| yield(element) }
+        break if @collection.size < BATCH_SIZE
+        self.response = @response.next_page
+      end
+    end
+
+    def response=(response)
+      @response = response
+      @collection = Array(response.data) || []
+      @size = response.count || 0
+      @page_count = response.page_count
+    end
+    private :response=
+  end
+end

data/lib/brewery_db/config.rb

@@ -2,19 +2,20 @@ require 'faraday'
 
 module BreweryDB
   class Config
-    ADAPTER = Faraday.default_adapter
-    ENDPOINT = 'http://api.brewerydb.com/v2'
-    MIDDLEWARE = []
+    BASE_URI = 'http://api.brewerydb.com/v2'
     USER_AGENT = "BreweryDB Ruby Gem #{BreweryDB::VERSION}"
+    TIMEOUT = 60
 
     attr_accessor :adapter
     attr_accessor :api_key
-    attr_accessor :endpoint
+    attr_accessor :base_uri
+    attr_accessor :timeout
     attr_accessor :user_agent
 
     def initialize
-      self.adapter = ADAPTER
-      self.endpoint = ENDPOINT
+      self.adapter = Faraday.default_adapter
+      self.base_uri = BASE_URI
+      self.timeout = TIMEOUT
       self.user_agent = USER_AGENT
     end
   end

data/lib/brewery_db/mash.rb

@@ -0,0 +1,18 @@
+require 'hashie'
+
+module BreweryDB
+  class Mash < 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
+    end
+    protected :convert_key
+
+    def convert_value(value, duping=false)
+      value.is_a?(String) ? super.gsub("\r\n", "\n") : super
+    end
+    protected :convert_value
+  end
+end