brewery_db 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+bin
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tyler Hunt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# BreweryDB
+
+A Ruby library for interfacing with the [BreweryDB][] API.
+
+[brewerydb]: http://www.brewerydb.com/
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'brewery_db'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brewery_db
+
+
+## Configuration
+
+You must have a valid API key to use the BreweryDB API. If you don't yet have
+one, you may [request one here][api-key].
+
+[api-key]: http://www.brewerydb.com/developers
+
+Use the following method to configure your API key:
+
+``` ruby
+BreweryDB.configure 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:
+
+``` ruby
+brewery_db = BreweryDB::Client.new
+
+brewery_db.configure do |config|
+  config.api_key = API_KEY
+end
+```
+
+
+## Usage
+
+Once the API key has been configured, resources may be called off the module
+directly or off your client instances:
+
+``` ruby
+BreweryDB.beers.all(abv: '5.5')
+BreweryDB.beers.find('vYlBZQ')
+
+BreweryDB.breweries.all(established: 2006)
+BreweryDB.breweries.find('d1zSa7')
+
+BreweryDB.categories.all
+BreweryDB.categories.find(1)
+
+BreweryDB.glassware.all
+BreweryDB.glassware.find(1)
+
+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')
+
+BreweryDB.styles.all
+BreweryDB.styles.find(1)
+```
+
+
+## Contributing
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Added some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.
+
+
+## Copyright
+
+Copyright © 2012 Tyler Hunt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'

data/brewery_db.gemspec

@@ -0,0 +1,22 @@
+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.homepage = 'http://github.com/tylerhunt/brewery_db'
+  gem.author = 'Tyler Hunt'
+
+  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_development_dependency 'vcr', '~> 2.0'
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/lib/brewery_db.rb

@@ -0,0 +1,36 @@
+require 'brewery_db/version'
+
+module BreweryDB
+  autoload :Client, 'brewery_db/client'
+  autoload :Config, 'brewery_db/config'
+  autoload :Resource, 'brewery_db/resource'
+  autoload :Response, 'brewery_db/response'
+
+  module Resources
+    autoload :Beers, 'brewery_db/resources/beers'
+    autoload :Breweries, 'brewery_db/resources/breweries'
+    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

@@ -0,0 +1,36 @@
+module BreweryDB
+  class Client
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+      config
+    end
+
+    def beers
+      @beers ||= Resources::Beers.new(self)
+    end
+
+    def breweries
+      @breweries ||= Resources::Breweries.new(self)
+    end
+
+    def categories
+      @categories ||= Resources::Categories.new(self)
+    end
+
+    def glassware
+      @glassware ||= Resources::Glassware.new(self)
+    end
+
+    def search
+      @search ||= Resources::Search.new(self)
+    end
+
+    def styles
+      @styles ||= Resources::Styles.new(self)
+    end
+  end
+end

data/lib/brewery_db/config.rb

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

data/lib/brewery_db/resource.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+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
+    end
+
+    def get(path, params={})
+      connection.get(path, default_params.merge(params)).body
+    end
+    private :get
+
+    def default_params
+      { key: @client.config.api_key }
+    end
+    private :default_params
+  end
+end

data/lib/brewery_db/resources/beers.rb

@@ -0,0 +1,13 @@
+module BreweryDB
+  module Resources
+    class Beers < Resource
+      def all(params={})
+        get('beers', params)
+      end
+
+      def find(id, params={})
+        get('beer/%s' % id, params)
+      end
+    end
+  end
+end

data/lib/brewery_db/resources/breweries.rb

@@ -0,0 +1,13 @@
+module BreweryDB
+  module Resources
+    class Breweries < Resource
+      def all(params={})
+        get('breweries', params)
+      end
+
+      def find(id, params={})
+        get('brewery/%s' % id, params)
+      end
+    end
+  end
+end

data/lib/brewery_db/resources/categories.rb

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

data/lib/brewery_db/resources/glassware.rb

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

data/lib/brewery_db/resources/search.rb

@@ -0,0 +1,25 @@
+module BreweryDB
+  module Resources
+    class Search < Resource
+      def all(params={})
+        get('search', params)
+      end
+
+      def beers(params={})
+        all(params.merge(type: 'beer'))
+      end
+
+      def breweries(params={})
+        all(params.merge(type: 'brewery'))
+      end
+
+      def guilds(params={})
+        all(params.merge(type: 'guild'))
+      end
+
+      def events(params={})
+        all(params.merge(type: 'event'))
+      end
+    end
+  end
+end

data/lib/brewery_db/resources/styles.rb

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

data/lib/brewery_db/response.rb

@@ -0,0 +1,18 @@
+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
+    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

data/lib/brewery_db/version.rb

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

data/spec/brewery_db/client_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe BreweryDB::Client do
+  context '#config' do
+    subject { described_class.new.config }
+
+    it { should be_a(BreweryDB::Config) }
+
+    its(:adapter) { should == BreweryDB::Config::ADAPTER }
+    its(:api_key) { should == nil }
+    its(:endpoint) { should == BreweryDB::Config::ENDPOINT }
+  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
+    end
+
+    its(:adapter) { should == :typhoeus }
+    its(:api_key) { should == 'A1029384756B' }
+    its(:endpoint) { should == 'http://api.playground.brewerydb.com' }
+  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
+    end
+  end
+end