brewerydb-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bc5e087055c6883f19dda0bf14616ef1cef6887
+  data.tar.gz: 6b342f65fc89717fdbd5352c562aa4c323337256
+SHA512:
+  metadata.gz: 4820468772b4fc5269fdde8d8f0e122a4677c0b59b5e5f878ab69e5262b8e1973ca4437e7eaa49612326a1ff0c57d45e18758260848191b3b914f27496b3b6dd
+  data.tar.gz: c970f18833d1adc2c972b5f0225465a2cc554e143bb00fdaebe3cd82f49b91661cff10dfed795c20f59f32a18c305bf98db88c139081384733dd0263300b6de5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+-Ilib -Ispec -rspec_helper --color --format progress --order rand

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brewerydb-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Maggie Rose
+
+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,58 @@
+# Brewerydb::Client
+
+# Installation
+
+Add this line to your application’s Gemfile:
+```
+gem 'brewerydb-client', require: 'brewerydb'
+```
+And then execute:
+
+```
+bundle
+```
+
+# 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.
+
+You can use the following method to configure your API key:
+```
+Brewerydb.configure do |config|
+  config.api_key = '123abc'
+end
+```
+
+# Usage
+Search for breweries with request parameters
+```
+breweries = Brewerydb::Brewery.index(established: 2016)
+
+breweries.map do |brewery|
+  puts brewery.id
+end
+```
+
+Find a specific brewery's name
+```
+Brewerydb::Brewery.show('yrqy3m').name
+```
+
+Searching for beers without parameters
+```
+beers = Brewerydb::Beer.index
+beers.map do |beer|
+  puts beer.style.category.name if beer.style
+end
+```
+
+Pagination data
+```
+beers.current_page
+beers.number_of_pages
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brewerydb/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brewerydb-client.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brewerydb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brewerydb-client"
+  spec.version       = Brewerydb::VERSION
+  spec.authors       = ["Maggie Rose"]
+  spec.email         = ["maggie.rose.g@gmail.com"]
+
+  spec.summary       = "Ruby client for BreweryDB API"
+  spec.description   = "Support for premium features of the API avaiable"
+  spec.homepage      = "https://github.com/MaggieRose810/brewerydb_ruby_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "activesupport", ">= 4.0.0", "< 6"
+  spec.add_dependency "recursive-open-struct"
+end

data/lib/brewerydb/adjunct.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Adjunct < Base
+    collection_path '/adjuncts'
+    member_path '/adjunct'
+  end
+end

data/lib/brewerydb/adjuncts.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Adjuncts < BaseCollection
+  end
+end

data/lib/brewerydb/base.rb

@@ -0,0 +1,61 @@
+module Brewerydb
+  class Base < RecursiveOpenStruct
+    def initialize(params, *options)
+      super convert_hash_keys(params), *options
+    end
+
+    def http
+      self.class.http
+    end
+
+    def self.http
+      Brewerydb::HTTP.new
+    end
+
+    def self.collection_path(path)
+      @collection_path = path
+    end
+
+    def self.member_path(path)
+      @member_path = path
+    end
+
+    def self.index(params = {})
+      response = http.get(@collection_path, params)
+      data = response.delete('data')
+      Brewerydb.const_get(ActiveSupport::Inflector.pluralize(self.name)).new(data, response)
+    end
+
+    def self.show(id, params = {})
+      response = http.get("#{@member_path}/#{id}", params)
+      Brewerydb.const_get(self.name).new(response['data'])
+    end
+
+    def self.create(params)
+      response = http.post(@collection_path, params)
+      Brewerydb.const_get(self.name).new(response['data'])
+    end
+
+    def self.update
+      response = http.put("#{@member_path}/#{id}", params)
+      Brewerydb.const_get(self.name).new(response['data'])
+    end
+
+    def self.delete
+      response = http.delete("#{@member_path}/#{id}")
+    end
+
+    private
+
+    def convert_hash_keys(value)
+      case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+        when Hash
+          Hash[value.map { |k, v| [k.to_s.underscore, convert_hash_keys(v)] }]
+        else
+          value
+       end
+    end
+  end
+end

data/lib/brewerydb/base_collection.rb

@@ -0,0 +1,25 @@
+module Brewerydb
+  class BaseCollection
+    include Enumerable
+    delegate :each, :<<, to: :items
+
+    def initialize(items, options = {})
+      klass = Brewerydb.const_get(ActiveSupport::Inflector.singularize(self.class.name))
+      @items =  Array(items).map { |i| i.is_a?(klass) ? i : klass.new(i) }
+      @options = options
+    end
+
+    def items
+      @items
+    end
+
+    def current_page
+      @options["currentPage"]
+    end
+
+    def number_of_pages
+      @options["numberOfPages"]
+    end
+
+  end
+end

data/lib/brewerydb/beer.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Beer < Base
+    collection_path '/beers'
+    member_path '/beer'
+  end
+end

data/lib/brewerydb/beers.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Beers < BaseCollection
+  end
+end

data/lib/brewerydb/breweries.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Breweries < BaseCollection
+  end
+end

data/lib/brewerydb/brewery.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Brewery < Base
+    collection_path '/breweries'
+    member_path '/brewery'
+  end
+end

data/lib/brewerydb/categories.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Categories < BaseCollection
+  end
+end

data/lib/brewerydb/category.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Category < Base
+    collection_path '/categories'
+    member_path '/category'
+  end
+end

data/lib/brewerydb/change.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Change < Base
+    collection_path '/changes'
+    member_path '/change'
+  end
+end

data/lib/brewerydb/changes.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Changes < BaseCollection
+  end
+end

data/lib/brewerydb/config.rb

@@ -0,0 +1,5 @@
+module Brewerydb
+  class Config
+    attr_accessor :api_key
+  end
+end

data/lib/brewerydb/event.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Event < Base
+    collection_path '/events'
+    member_path '/event'
+  end
+end

data/lib/brewerydb/events.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Events < BaseCollection
+  end
+end

data/lib/brewerydb/feature.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Feature < Base
+    collection_path '/features'
+    member_path '/feature'
+  end
+end

data/lib/brewerydb/features.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Features < BaseCollection
+  end
+end

data/lib/brewerydb/fermentable.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Fermentable < Base
+    collection_path '/fermentables'
+    member_path '/fermentable'
+  end
+end

data/lib/brewerydb/fermentables.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Fermentables < BaseCollection
+  end
+end

data/lib/brewerydb/fluidsize.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Fluidsize < Base
+    collection_path '/fluidsizes'
+    member_path '/fluidsize'
+  end
+end

data/lib/brewerydb/fluidsizes.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Fluidsizes < BaseCollection
+  end
+end

data/lib/brewerydb/glass.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Glass < Base
+    collection_path '/glassware'
+    member_path '/glass'
+  end
+end

data/lib/brewerydb/glassware.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Glassware < BaseCollection
+  end
+end

data/lib/brewerydb/guild.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Guild < Base
+    collection_path '/guilds'
+    member_path '/guild'
+  end
+end

data/lib/brewerydb/guilds.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Guilds < BaseCollection
+  end
+end

data/lib/brewerydb/hop.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Hop < Base
+    collection_path '/hops'
+    member_path '/hop'
+  end
+end

data/lib/brewerydb/hops.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Hops < BaseCollection
+  end
+end

data/lib/brewerydb/http.rb

@@ -0,0 +1,57 @@
+require "net/http"
+require "json"
+require "uri"
+
+module Brewerydb
+  class HTTP
+    def initialize
+      @host = 'api.brewerydb.com'
+      @api_version = 'v2'
+    end
+
+    def get(path, params)
+      uri = base_uri(path)
+      uri.query = URI.encode_www_form(params_with_key(params))
+      res = Net::HTTP.get_response(uri)
+      parse_response(res)
+    end
+
+    def post(path, params)
+      uri = base_uri(path)
+      res = Net::HTTP.post_form(uri, params_with_key(params))
+      parse_response(res)
+    end
+
+    def put(path, params)
+      request = Net::HTTP::Put.new(path)
+      req.body = params_with_key(params)
+      res = Net::HTTP.new(@host).start { |http| http.request(req)}
+      parse_response(res)
+    end
+
+    def delete(path)
+      res = Net::HTTP.new(@host).delete(path)
+      parse_response(res)    end
+
+    private
+
+    def base_uri(path)
+       URI("http://#{@host}/#{@api_version}#{path}")
+    end
+
+    def parse_response(res)
+       if res.is_a?(Net::HTTPSuccess)
+        JSON.parse(res.body)
+      else
+        raise "Invalid response #{res.code} #{res.body}"
+      end
+    end
+
+    def params_with_key(params)
+      params.merge({
+        key: Brewerydb.config.api_key
+      })
+    end
+
+  end
+end

data/lib/brewerydb/ingredient.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Ingredient < Base
+    collection_path '/ingredients'
+    member_path '/ingredient'
+  end
+end

data/lib/brewerydb/ingredients.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Ingredients < BaseCollection
+  end
+end

data/lib/brewerydb/location.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Location < Base
+    collection_path '/locations'
+    member_path '/location'
+  end
+end

data/lib/brewerydb/locations.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Locations < BaseCollection
+  end
+end

data/lib/brewerydb/socialsite.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Socialsite < Base
+    collection_path '/socialsites'
+    member_path '/socialsite'
+  end
+end

data/lib/brewerydb/socialsites.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Socialsites < BaseCollection
+  end
+end

data/lib/brewerydb/style.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Style < Base
+    collection_path '/styles'
+    member_path '/style'
+  end
+end

data/lib/brewerydb/styles.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Styles < BaseCollection
+  end
+end

data/lib/brewerydb/version.rb

@@ -0,0 +1,3 @@
+module Brewerydb
+  VERSION = "0.0.1"
+end

data/lib/brewerydb/yeast.rb

@@ -0,0 +1,6 @@
+module Brewerydb
+  class Yeast < Base
+    collection_path '/yeasts'
+    member_path '/yeast'
+  end
+end

data/lib/brewerydb/yeasts.rb

@@ -0,0 +1,4 @@
+module Brewerydb
+  class Yeasts < BaseCollection
+  end
+end

data/lib/brewerydb.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'net/http'
+require 'json'
+require 'ostruct'
+Bundler.setup
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'recursive-open-struct'
+require_relative 'brewerydb/config'
+require_relative 'brewerydb/base'
+require_relative 'brewerydb/base_collection'
+require_relative 'brewerydb/http'
+
+require_relative 'brewerydb/adjunct'
+require_relative 'brewerydb/adjuncts'
+require_relative 'brewerydb/brewery'
+require_relative 'brewerydb/breweries'
+require_relative 'brewerydb/beer'
+require_relative 'brewerydb/beers'
+require_relative 'brewerydb/category'
+require_relative 'brewerydb/categories'
+require_relative 'brewerydb/change'
+require_relative 'brewerydb/changes'
+require_relative 'brewerydb/event'
+require_relative 'brewerydb/events'
+require_relative 'brewerydb/feature'
+require_relative 'brewerydb/features'
+require_relative 'brewerydb/fermentable'
+require_relative 'brewerydb/fermentables'
+require_relative 'brewerydb/fluidsize'
+require_relative 'brewerydb/fluidsizes'
+require_relative 'brewerydb/glass'
+require_relative 'brewerydb/glassware'
+require_relative 'brewerydb/hop'
+require_relative 'brewerydb/hops'
+require_relative 'brewerydb/ingredient'
+require_relative 'brewerydb/ingredients'
+require_relative 'brewerydb/location'
+require_relative 'brewerydb/locations'
+require_relative 'brewerydb/socialsite'
+require_relative 'brewerydb/socialsites'
+require_relative 'brewerydb/style'
+require_relative 'brewerydb/styles'
+require_relative 'brewerydb/yeast'
+require_relative 'brewerydb/yeasts'
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.irregular 'glass', 'glassware'
+end
+
+module Brewerydb
+  def self.configure
+    @config = Brewerydb::Config.new
+    yield(@config)
+  end
+
+  def self.config
+    @config
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: brewerydb-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maggie Rose
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support for premium features of the API avaiable
+email:
+- maggie.rose.g@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brewerydb-client.gemspec
+- lib/brewerydb.rb
+- lib/brewerydb/adjunct.rb
+- lib/brewerydb/adjuncts.rb
+- lib/brewerydb/base.rb
+- lib/brewerydb/base_collection.rb
+- lib/brewerydb/beer.rb
+- lib/brewerydb/beers.rb
+- lib/brewerydb/breweries.rb
+- lib/brewerydb/brewery.rb
+- lib/brewerydb/categories.rb
+- lib/brewerydb/category.rb
+- lib/brewerydb/change.rb
+- lib/brewerydb/changes.rb
+- lib/brewerydb/config.rb
+- lib/brewerydb/event.rb
+- lib/brewerydb/events.rb
+- lib/brewerydb/feature.rb
+- lib/brewerydb/features.rb
+- lib/brewerydb/fermentable.rb
+- lib/brewerydb/fermentables.rb
+- lib/brewerydb/fluidsize.rb
+- lib/brewerydb/fluidsizes.rb
+- lib/brewerydb/glass.rb
+- lib/brewerydb/glassware.rb
+- lib/brewerydb/guild.rb
+- lib/brewerydb/guilds.rb
+- lib/brewerydb/hop.rb
+- lib/brewerydb/hops.rb
+- lib/brewerydb/http.rb
+- lib/brewerydb/ingredient.rb
+- lib/brewerydb/ingredients.rb
+- lib/brewerydb/location.rb
+- lib/brewerydb/locations.rb
+- lib/brewerydb/socialsite.rb
+- lib/brewerydb/socialsites.rb
+- lib/brewerydb/style.rb
+- lib/brewerydb/styles.rb
+- lib/brewerydb/version.rb
+- lib/brewerydb/yeast.rb
+- lib/brewerydb/yeasts.rb
+homepage: https://github.com/MaggieRose810/brewerydb_ruby_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for BreweryDB API
+test_files: []