Brewry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 794dc054972a8ad20a14fdbddb8a54985d7f72b8
+  data.tar.gz: 39ab0e85495ef0afa31e96785e4b1dd76f61799e
+SHA512:
+  metadata.gz: 3a008be39c6dd7dfeb84186473b98e3fb189990ead2e2041cdca4bd09f185ed84af64ea2078af09f396979d69090e8160b53331e95cd1ee802e4a280a197f223
+  data.tar.gz: 4f4aea34da4154ca7853db8461e16b888d74d43921a47a4773424ec1b0fae8fb2fcf16033b6a4c462080b71f36cde0a859d309bd35dc1310a3deebc2f0c17c22

data/.gitignore

@@ -0,0 +1 @@
+Brewry-*

data/README.rdoc

@@ -0,0 +1,41 @@
+== Brewry
+
+Brewry gives you an API interface to talk to BreweryDB.
+
+* It retuns everything as a hash so you can just pass it to ActiveRecord
+* It recursively changes the hash to change the 'id' keys into 'guid' so it
+  doesn't interfere with your own ActiveRecord Ids. Changing it to whatever you
+  want is on the works.
+* Because of metaprogramming, very little code is needed to touch most api
+  endoints for BreweryDB.
+
+== Configuration
+
+For Rails:
+
+Create an initializer in config/initializers/brewry.rb
+
+  Brewry.configure do |config|
+    config.api_key = 'some api key'
+  end
+
+== Examples
+
+Fetch some beers with the name argument:
+
+  Brewry.search_beers(name: 'Corona Light')
+
+Fetch some styles without arguments - this will return all beer styles:
+
+  Brewry.search_styles
+
+== Releases
+
+0.0.1
+* Initialize project
+
+== TODO
+
+* Change class so it can be instantiated.
+* Add tests
+* Allow changing of breweryDB id's into whatever the user needs.

data/brewry.gemspec

@@ -0,0 +1,21 @@
+require './lib/brewry/version'
+
+Gem::Specification.new do |s|
+  s.name            = 'Brewry'
+  s.version         = Brewry::VERSION
+  s.summary         = 'Brewry provides an interface to the BreweryDB API.'
+  s.description     =  'Brewry provides an interface to the BreweryDB API. Instead of returning a struct or some other Brewry instance, it returns a hash that can quickly be inserted into ActiveRecord. It also allows you to replace the keys for certain results such as key so you can keep track of them with your own id\'s.'
+  s.authors         = ['Daniel Ochoa']
+  s.email           = ['dannytenaglias@gmail.com']
+  s.homepage        = 'https://github.com/DanyHunter/brewry'
+  s.license         = 'MIT'
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_dependency 'httparty', '~> 0.13'
+
+  s.files         = `git ls-files`.split($\)
+  s.require_paths = ['lib']
+  s.executables   = s.files.grep(%r{^bin/}).map {|f| File.basename(f)}
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+end

data/lib/brewry/version.rb

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

data/lib/brewry.rb

@@ -0,0 +1,114 @@
+require 'rubygems'
+require 'httparty'
+require_relative 'utils/brewry_string_utils'
+
+class Brewry
+  # TODO: Change class so it needs to be instantiated
+  using BrewryStringUtils
+  include HTTParty
+
+  attr_accessor :search_hash
+
+  ### Configuration ###
+
+  base_uri 'http://api.brewerydb.com/v2'
+  @@api_key = nil
+
+  # Brewry.configure do |config|
+  #   config.api_key = 'some_api_key'
+  # end
+  def self.configure
+    yield self
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(apikey)
+    @@api_key = apikey
+  end
+
+  ### Methods ###
+
+  # override method_missing in order to create
+  # dynamic methods for searches. Ex.:
+  # BreweryDB.search_beers(name: 'Corona Light')
+  # BreweryDB.search_styles()
+  def self.method_missing(meth, *args, &block)
+    if meth.to_s =~ /^search_(.+)$/
+      search_for($1, *args)
+    else
+      super
+    end
+  end
+
+  # standard beer search - WILL DEPRECATE IN THE FUTURE
+  def self.beer_search(search)
+    query  = build_query q: search, type: 'beer'
+    search = get('/search', query)
+    return_pretty_results(search)
+  end
+
+  # returns raw httparty query. See
+  # http://www.brewerydb.com/developers/docs
+  # for full range of options
+  def self.raw_query(path, options)
+    query = build_query(options)
+    get(path, query)
+  end
+
+  # To use BreweryDB search path. Options are:
+  # Ex. { q: 'Goosinator', type: 'beer' }
+  def self.search(options)
+    query   = build_query options
+    search  = get('/search', query)
+    return_pretty_results(search)
+  end
+
+  protected
+
+  # Used by the method_missing method for dynamic searches
+  def self.search_for(path, options = {})
+    query   = build_query(options)
+    search  = get("/#{path}", query)
+    return_pretty_results(search)
+  end
+
+  # underscore_and_symbolize is defined in utils/api_utilities.rb
+  def self.return_pretty_results(payload)
+    return query_error(payload) if payload['status'] == 'failure'
+    data = payload.parsed_response['data']
+    data.map do |obj|
+      obj = self.underscore_and_symbolize obj
+    end if data
+  end
+
+  def self.build_query(search = {})
+    search_hash = clean_search_hash
+    search_hash[:query].merge! search; search_hash
+  end
+
+  def self.query_error(search)
+    self.underscore_and_symbolize search
+    # TODO: throw some exception or special fail construct
+  end
+
+  def self.clean_search_hash
+    { query: { key: @@api_key } }
+  end
+
+  # TODO: User should be able to change the foreignkeys argument
+  def self.underscore_and_symbolize(obj, foreignkeys = :guid)
+    obj.inject({}) do |hash, (key, val)|
+      val = underscore_and_symbolize(val) if val.kind_of? Hash
+      if key == 'id'
+        hash.shift
+        hash[foreignkeys] = val
+      else
+        hash[key.underscore.to_sym] = val
+      end
+      hash
+    end
+  end
+end

data/lib/utils/brewry_string_utils.rb

@@ -0,0 +1,14 @@
+module BrewryStringUtils
+  # This is a ruby refinement. Only works in ruby >= 2.0
+  # This method is monkey patched into String when using Rails, but in this
+  # fashion it will always be scoped to the BrewryStringUtils module.
+  refine String do
+    def underscore
+      self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: Brewry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Ochoa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Brewry provides an interface to the BreweryDB API. Instead of returning
+  a struct or some other Brewry instance, it returns a hash that can quickly be inserted
+  into ActiveRecord. It also allows you to replace the keys for certain results such
+  as key so you can keep track of them with your own id's.
+email:
+- dannytenaglias@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.rdoc
+- brewry.gemspec
+- lib/brewry.rb
+- lib/brewry/version.rb
+- lib/utils/brewry_string_utils.rb
+homepage: https://github.com/DanyHunter/brewry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Brewry provides an interface to the BreweryDB API.
+test_files: []