rate_beer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e99b34421fce5318a0b1385002b174ac156b2b4b
+  data.tar.gz: b8338d4682bc2f7128c8d17a958407a52cd2b3e7
+SHA512:
+  metadata.gz: d24a55e950209e4d2f0d4fa675d8842c5cf5b63b4ee130141c9f2bbccd6ba4d9ff32dd56cece279ccd8bab6922e489c17279d988ad02b4e75c7533d71008a432
+  data.tar.gz: 3bb5d7541fdb4e6e2541e017c1af93d3a741e9f57cd9ba32d73bb2966f071c4d852d14b410142324d3e4e42ed213de9c92933b865a8fd767d40861981ef4fe30

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rate_beer.gemspec
+gemspec
+
+group :development, :test do 
+  gem "byebug"
+  gem "pry"
+end
+group :test do 
+  gem 'rspec', '~> 2.14'
+  gem 'webmock'
+  gem 'simplecov', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Māris Cīlītis
+
+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,29 @@
+# RateBeer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rate_beer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rate_beer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rate_beer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rate_beer.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require "rate_beer/version"
+require 'rate_beer/configuration'
+require 'rate_beer/client'
+require 'rate_beer/string'
+
+module RateBeer
+  extend Configuration
+end

data/lib/rate_beer/client.rb

@@ -0,0 +1,72 @@
+require 'uri'
+require 'hashie'
+
+module RateBeer
+  class Client
+    include HTTParty
+
+    SORT_OPTIONS = {
+      latest: 1,
+      top_raters: 2,
+      highest_ratings: 3
+    }.freeze
+
+    DEFAULT_OPTIONS = {
+      page: 1,
+      sort_by: SORT_OPTIONS[:latest]
+    }.freeze
+
+    base_uri Configuration::DEFAULT_ENDPOINT
+
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options = {})
+      merged_options = RateBeer.options.merge(options)
+
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def beer_info_by_id(beer_id)
+      response = self.class.get("/bff.asp?bd=#{beer_id}&k=#{api_key}")
+      parsed_response(response)
+    end
+
+    def beer_info_by_name(beer_name)
+      beer_name = URI.escape(beer_name)
+      response = self.class.get("/bff.asp?bn=#{beer_name}&k=#{api_key}&vg=1&rc=1")
+      parsed_response(response)
+    end
+
+    def beer_reviews(beer_id, options = {})
+      options = merge_with_default_options(options)
+      response = self.class.get("/gr.asp?bid=#{beer_id}&s=#{options[:sort_by]}&p=#{options[:page]}&k=#{api_key}")
+      parsed_response(response)
+    end
+
+    private
+
+    def merge_with_default_options(options)
+      DEFAULT_OPTIONS.merge(options)
+    end
+
+    def parsed_response(response)
+      parsed_array = JSON.parse(response.body)
+      parsed_array.each_with_index do |hash, index|
+        hash = hash_with_transformed_keys(hash)
+        hash = transformed_to_mash(hash)
+        parsed_array[index] = hash
+      end
+      parsed_array
+    end
+
+    def hash_with_transformed_keys(hash)
+      hash.inject({}){|memo,(k,v)| memo[k.underscore] = v; memo}
+    end
+
+    def transformed_to_mash(hash)
+      Hashie::Mash.new(hash)
+    end
+  end
+end

data/lib/rate_beer/configuration.rb

@@ -0,0 +1,31 @@
+module RateBeer
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent].freeze
+    VALID_OPTIONS_KEYS = [:api_key].freeze
+    VALID_CONFIG_KEYS = VALID_OPTIONS_KEYS + VALID_CONNECTION_KEYS
+
+    DEFAULT_API_KEY = nil
+    DEFAULT_USER_AGENT = "RateBeer API Ruby Gem #{RateBeer::VERSION}"
+    DEFAULT_ENDPOINT = 'http://ratebeer.com/json'
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.api_key = DEFAULT_API_KEY
+      self.user_agent = DEFAULT_USER_AGENT
+      self.endpoint = DEFAULT_ENDPOINT
+    end
+  end
+end

data/lib/rate_beer/string.rb

@@ -0,0 +1,9 @@
+class String
+  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

data/lib/rate_beer/version.rb

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

data/rate_beer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rate_beer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rate_beer"
+  spec.version       = RateBeer::VERSION
+  spec.authors       = ["Māris Cīlītis"]
+  spec.email         = ["maris@ithouse.lv"]
+  spec.summary       = %q{A Ruby interface to Rate Beer API}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashie"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+
+SimpleCov.start
+require 'rspec'
+require 'rate_beer'
+require 'webmock/rspec'
+require 'byebug'
+require 'json'
+require 'hashie'
+require 'support/responses'

data/spec/rate_beer/client_spec.rb

@@ -0,0 +1,177 @@
+require 'helper'
+
+describe RateBeer::Client do 
+  subject { described_class.new  }
+
+  before do
+    @keys = RateBeer::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      RateBeer.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      RateBeer.reset
+    end
+
+    it "should inherit module configuration" do
+      api = RateBeer::Client.new
+      @keys.each do |key|
+        expect(api.send(key)).to equal(key)
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :api_key    => 'ak',
+          :endpoint   => 'ep',
+          :user_agent => 'ua'
+        }
+      end
+
+      it 'should override module configuration' do
+        api = RateBeer::Client.new(@config)
+        @keys.each do |key|
+          expect(api.send(key)).to equal(@config[key])
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = RateBeer::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          expect(api.send("#{key}")).to equal(@config[key])
+        end
+      end
+    end
+  end
+
+  it "should include http party" do
+    expect(RateBeer::Client).to include(HTTParty)
+  end
+
+  it "shold have correct base uri" do
+    expect(RateBeer::Client.base_uri).to eq(RateBeer::Configuration::DEFAULT_ENDPOINT)
+  end
+
+
+  let(:client) { described_class.new(api_key: "secret123") }
+
+  describe "#beer_info_by_id" do
+    before do 
+      stub_request(:get, "http://ratebeer.com/json/bff.asp?bd=12345&k=secret123").
+         to_return(:status => 200, :body => response_by_beer_id, :headers => {})
+    end
+
+    let(:response) { client.beer_info_by_id("12345") }
+
+    it "should return Array" do
+      expect(response).to be_a(Array)
+    end
+
+    describe "response" do 
+      subject { response[0] }
+
+      it "should return correct values" do
+        expect(subject.beer_id).to eq(12345)
+        expect(subject.beer_name).to eq("Acoustic Harmonic Bzzz")
+        expect(subject.brewer_id).to eq(12147)
+        expect(subject.brewer_name).to eq("Acoustic Brewing Company")
+        expect(subject.overall_pctl).to eq(57.751660219715)
+        expect(subject.style_pctl).to eq(53.0867326920712)
+        expect(subject.beer_style_name).to eq("Mead")
+        expect(subject.alcohol).to eq(6)
+        expect(subject.ibu).to eq(nil)
+        expect(subject.description).to eq("Honey-apple-cherry wine fermented and flavored with natural fruit and spices.")
+        expect(subject.is_alias).to eq(false)
+      end
+    end
+  end
+
+  describe "#beer_info_by_name" do
+    before do 
+      stub_request(:get, "http://ratebeer.com/json/bff.asp?bn=Acoustic%20Harmonic%20Bzzz&k=secret123&rc=1&vg=1").
+         to_return(:status => 200, :body => response_by_beer_name, :headers => {})
+    end
+
+    let(:response) { client.beer_info_by_name("Acoustic Harmonic Bzzz") }
+
+    it "should return Array" do
+      expect(response).to be_a(Array)
+    end
+
+    describe "response" do 
+      subject { response[0] }
+
+      it "should return correct values" do
+        expect(subject.beer_id).to eq(12345)
+        expect(subject.beer_name).to eq("Acoustic Harmonic Bzzz")
+        expect(subject.overall_pctl).to eq(57.751660219715)
+        expect(subject.style_pctl).to eq(53.0867326920712)
+        expect(subject.is_alias).to eq(false)
+        expect(subject.rate_count).to eq(9)
+        expect(subject.average_rating).to eq(3.156209)
+        expect(subject.real_average).to eq(3.433333)
+      end
+    end
+  end
+
+  describe "#beer_reviews" do 
+    before do 
+      stub_request(:get, "http://ratebeer.com/json/gr.asp?bid=12345&k=secret123&p=1&s=1").
+         to_return(:status => 200, :body => beer_reviews_response, :headers => {})
+    end
+
+    let(:response) { client.beer_reviews("12345") }
+    let(:review) { response.first }
+
+    it "should return Array" do
+      expect(response).to be_a(Array)
+    end
+
+    describe "response" do 
+      subject { response }
+
+      it "should contain hashes" do
+        expect(subject.first).to be_a(Hash)
+      end
+
+      it "should contain 2 reviews" do
+        expect(subject.count).to eq(2)
+      end
+
+      it "should contain correct values" do
+        expect(review.result_num).to eq(1)
+        expect(review.rating_id).to eq(5525608)
+        expect(review.appearance).to eq(3)
+        expect(review.aroma).to eq(6)
+        expect(review.flavor).to eq(6)
+        expect(review.mouthfeel).to eq(3)
+        expect(review.overall).to eq(12)
+        expect(review.total_score).to eq(3)
+        expect(review.comments).to eq("Bottle. Clear gold with a thin white head. Aroma of honey and slight apple. Flavor of honey and lemon soda.")
+        expect(review.time_entered).to eq("3/9/2014 11:55:13 AM")
+        expect(review.time_updated).to eq(nil)
+        expect(review.user_id).to eq(76728)
+        expect(review.user_name).to eq("JaBier")
+        expect(review.city).to eq("Capital City")
+        expect(review.state_id).to eq(35)
+        expect(review.state).to eq("Ohio")
+        expect(review.country_id).to eq(213)
+        expect(review.country).to eq("United States")
+        expect(review.rate_count).to eq(4443)
+      end
+    end
+  end
+end

data/spec/rate_beer/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+describe 'configuration' do
+  subject { RateBeer }
+  
+  context "default configuration" do
+    RateBeer::Configuration::VALID_CONFIG_KEYS.each do |key|
+      describe ".#{key}" do
+        it 'should return the default value' do
+          expect(subject.send(key)).to eq(RateBeer::Configuration.const_get("DEFAULT_#{key.upcase}"))
+        end
+      end
+    end
+  end
+
+  context "custom configuration" do
+   RateBeer::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        subject.configure do |config|
+          config.send("#{key}=", key)
+          expect(subject.send(key)).to equal(key)
+        end
+      end
+    end 
+  end
+end

data/spec/rate_beer/rate_beer_spec.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe RateBeer do 
+  it "should have version" do
+    expect(RateBeer::VERSION).to_not eq(nil)
+  end
+end

data/spec/support/responses.rb

@@ -0,0 +1,11 @@
+def response_by_beer_id
+  "[{\"BeerID\":12345,\"BeerName\":\"Acoustic Harmonic Bzzz\",\"BrewerID\":12147,\"BrewerName\":\"Acoustic Brewing Company\",\"OverallPctl\":57.751660219715,\"StylePctl\":53.0867326920712,\"BeerStyleName\":\"Mead\",\"Alcohol\":6,\"IBU\":null,\"Description\":\"Honey-apple-cherry wine fermented and flavored with natural fruit and spices.\",\"IsAlias\":false}]"
+end
+
+def response_by_beer_name
+"[{\"BeerID\":12345,\"BeerName\":\"Acoustic Harmonic Bzzz\",\"IsAlias\":false,\"OverallPctl\":57.751660219715,\"StylePctl\":53.0867326920712,\"RealAverage\":3.433333,\"AverageRating\":3.156209,\"RateCount\":9}]"
+end
+
+def beer_reviews_response
+"[{\"resultNum\":1,\"RatingID\":5525608,\"Appearance\":3,\"Aroma\":6,\"Flavor\":6,\"Mouthfeel\":3,\"Overall\":12,\"TotalScore\":3,\"Comments\":\"Bottle. Clear gold with a thin white head. Aroma of honey and slight apple. Flavor of honey and lemon soda.\",\"TimeEntered\":\"3/9/2014 11:55:13 AM\",\"TimeUpdated\":null,\"UserID\":76728,\"UserName\":\"JaBier\",\"City\":\"Capital City\",\"StateID\":35,\"State\":\"Ohio\",\"CountryID\":213,\"Country\":\"United States\",\"RateCount\":4443},{\"resultNum\":2,\"RatingID\":5365050,\"Appearance\":3,\"Aroma\":8,\"Flavor\":7,\"Mouthfeel\":4,\"Overall\":15,\"TotalScore\":3.7,\"Comments\":\"Pours a light red colored hue. Aromas is of cherry and apple, sweet and fruity. Flavor is nice. Apple up front, nice and sweet. Sweet cherry juice with subtle tartness as well. Hints of cinnamon and all spice. Another solid offering. Like these light carbonated meads. \",\"TimeEntered\":\"1/4/2014 6:56:21 PM\",\"TimeUpdated\":null,\"UserID\":55709,\"UserName\":\"MeadMe\",\"City\":\"Riverview\",\"StateID\":9,\"State\":\"Florida\",\"CountryID\":213,\"Country\":\"United States\",\"RateCount\":1237}]"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rate_beer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Māris Cīlītis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A Ruby interface to Rate Beer API
+email:
+- maris@ithouse.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rate_beer.rb
+- lib/rate_beer/client.rb
+- lib/rate_beer/configuration.rb
+- lib/rate_beer/string.rb
+- lib/rate_beer/version.rb
+- rate_beer.gemspec
+- spec/helper.rb
+- spec/rate_beer/client_spec.rb
+- spec/rate_beer/configuration_spec.rb
+- spec/rate_beer/rate_beer_spec.rb
+- spec/support/responses.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to Rate Beer API
+test_files:
+- spec/helper.rb
+- spec/rate_beer/client_spec.rb
+- spec/rate_beer/configuration_spec.rb
+- spec/rate_beer/rate_beer_spec.rb
+- spec/support/responses.rb
+has_rdoc: