punkapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70e56cc88baa0bdda496590c7557e462520b55fe
+  data.tar.gz: 6a55a5db53d09dbe2ddaf7668ca3a2940164a43a
+SHA512:
+  metadata.gz: 4c220e1ac9e6a2fc9e5cc825d361af6150c04c91cf31b23462e1f04b8811a5d89b211e5e324edb90c615505c2a8335ecb8c2e8fae43a8f8fa45f047cf4457e5a
+  data.tar.gz: 291a09cd7de155a40dffdaf6b14191118fe7cbd4d0c9b9f927fa3fb731329e1c51ccef8e23fc69993d8636d0493fecd61e2f893ff6ad49823a9af68620979f49

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+*.gem
+.env

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at samm@lostmy.name. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sam Mason
+
+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,72 @@
+# punkapi [![Build Status](https://travis-ci.org/samjbmason/punkapi-ruby.svg?branch=master)](https://travis-ci.org/samjbmason/punkapi-ruby)
+
+A ruby wrapper for the PunkAPI, an API that takes Brewdog's DIY Dog and makes it into a JSON API. Read more about it [here](https://github.com/samjbmason/punkapi)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'punkapi', '~> 1.0.0'
+```
+
+Or install it yourself as:
+
+```
+$ gem install punkapi-ruby
+```
+
+## Usage
+
+### Initialize
+
+```ruby
+client = PunkAPI::Client.new(API_KEY)
+```
+
+### Get a Beer
+```ruby
+client.beer(2)
+
+=> #<PunkAPI::Entity id=2, name="Trashy Blonde", tagline="You Know You Shouldn't", first_brewed="April 2008", ...
+```
+
+### Get a random Beer
+```ruby
+client.random_beer
+
+=> #<PunkAPI::Entity id=138, name="Dog A", tagline="Cacao, Coffee, Chili Imperial Anniversary Stout.", first_brewed="May 2012", ...
+```
+
+### Get Beers
+This will return an array of `PunkAPI::Entity` objects in chronological order from `first_brewed` date. You can also pass any of the query paramters from the docs as an argument.
+
+```ruby
+client.beers(beer_name: 'Dog A')
+
+=> [#<PunkAPI::Entity id=138, name="Dog A", tagline="Cacao, Coffee, Chili Imperial Anniversary Stout.", first_brewed="May 2012", ...]
+```
+
+### Accessing data
+You can access the attributes using the ruby dot notation
+
+```ruby
+beers = client.beers(beer_name: 'Dog A')
+
+beers.first.name
+
+=> "Dog A"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/samjbmason/punkapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/punkapi.rb

@@ -0,0 +1,5 @@
+module PunkAPI
+  require 'punkapi/client'
+  require 'punkapi/version'
+  require 'punkapi/entity'
+end

data/lib/punkapi/client.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'json'
+
+module PunkAPI
+  class Client
+    attr_reader :api_key
+
+    DEFAULT_API_URL = 'https://punkapi.com/api/v1'
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def beer(id)
+      request('beers', id: id)
+    end
+
+    def beers(params = {})
+      request('beers', params)
+    end
+
+    def random_beer
+      request('beers/random')
+    end
+
+    def request(url, params = {})
+      url += "/#{params.delete(:id)}" if params[:id]
+      res = connection.get url, params
+      parse(res)
+    end
+
+    def parse(res)
+      response = JSON.parse(res.body, object_class: PunkAPI::Entity)
+      response.code = res.status unless res.success?
+      response
+    end
+
+    def connection
+      @connection ||= Faraday.new(DEFAULT_API_URL, ssl: { verify: false })
+      @connection.basic_auth(@api_key, '')
+      @connection
+    end
+  end
+end

data/lib/punkapi/entity.rb

@@ -0,0 +1,4 @@
+module PunkAPI
+  class Entity < OpenStruct
+  end
+end

data/lib/punkapi/version.rb

@@ -0,0 +1,3 @@
+module PunkAPI
+  VERSION = '1.0.0'.freeze
+end

data/punkapi.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'punkapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'punkapi'
+  spec.version       = PunkAPI::VERSION.dup
+  spec.authors       = ['Sam Mason']
+  spec.email         = ['sam.jbmason@gmail.com']
+
+  spec.summary       = 'A wrapper for the PunkAPI, well...API'
+  spec.description   = 'A wrapper for the PunkAPI, well...API'
+  spec.homepage      = 'https://github.com/samjbmason/punkapi-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'dotenv', '~> 2.1.0'
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe PunkAPI::Client do
+  let(:client) { PunkAPI::Client.new(ENV['API_KEY']) }
+
+  it 'has a version number' do
+    expect(PunkAPI::VERSION).not_to be nil
+  end
+
+  describe '#beer' do
+    it 'given an id, returns a PunkAPI::Entity object' do
+      beer = client.beer(1)
+      expect(beer).to be_a PunkAPI::Entity
+      expect(beer.name).to eq('Buzz')
+    end
+  end
+
+  describe '#random_beer' do
+    it 'returns a random PunkAPI::Entity object' do
+      beer = client.random_beer
+      expect(beer).to be_a PunkAPI::Entity
+      expect(beer.id).to be_between(1, 215)
+    end
+  end
+
+  describe '#beers' do
+    it 'returns a PunkAPI::Entity object with an abv greater than 10' do
+      beers = client.beers(abv_gt: 10)
+      expect(beers[0]).to be_a PunkAPI::Entity
+      expect(beers[0].abv).to be > 10
+    end
+
+    it 'returns a PunkAPI::Entity object with a name matching Punk' do
+      beers = client.beers(beer_name: 'Punk')
+      expect(beers[0]).to be_a PunkAPI::Entity
+      expect(beers[0].name).to include('Punk')
+    end
+
+    it 'returns 25 PunkAPI::Entity objects' do
+      beers = client.beers
+      expect(beers[0]).to be_a PunkAPI::Entity
+      expect(beers.count).to eq(25)
+    end
+
+    context 'incorrect api_key' do
+      it 'returns an error status of 401' do
+        client = PunkAPI::Client.new('fake')
+        resp = client.beers
+        expect(resp.code).to eq(401)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'dotenv'
+Dotenv.load
+require 'punkapi'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: punkapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sam Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A wrapper for the PunkAPI, well...API
+email:
+- sam.jbmason@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/punkapi.rb
+- lib/punkapi/client.rb
+- lib/punkapi/entity.rb
+- lib/punkapi/version.rb
+- punkapi.gemspec
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/samjbmason/punkapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: A wrapper for the PunkAPI, well...API
+test_files:
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb