kegbot_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18e3dfc1d6222d9c0b416ee462558e52fcc2bc4f
+  data.tar.gz: aa9ee8559db9fbfcacff6e02dd05404b690260d9
+SHA512:
+  metadata.gz: 1770d0e990bd6258a7c772eba65c0833a91e72c4ecc8e532780779f9a1b79c2c8cb486e0af0a92d47c337e627fc46625f2fba1733c0edc64b40cc033779eec17
+  data.tar.gz: 914fa3fd62521aaedcb15daf14af94127cfdfc8bc1fd3dbdd24d41a17b27263a0196bf94f64b1a5a2da0d5bc9892fca4672d680b1242506d0bf5e63cccd63adb

data/.gitignore

@@ -0,0 +1,24 @@
+*~
+
+# /temp* files used for prototyping + hacks.  usually temp.rb
+/temp*
+
+# Default GEM .gitignore
+
+*.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/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3-p194  # Ruby version on Ubuntu
+  - 1.9.3       # Latest in 1.9.3 series
+  - 2.0.0       # Latest in 2.0.0 series
+  - 2.1.1       # Latest
+before_script:
+  - gem install bundler --version "~> 1.5"
+  - bundle install
+script: bundle exec rspec -fd

data/.yardopts

@@ -0,0 +1 @@
+- README.md CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## Version 0.0.1 (Feb 28, 2014)
+
+#### Added
+
+* Initial working version
+# Added REST nouns (and associations):
+    * Session
+    * Keg
+        * Type
+            * Image
+        * Size
+    * Tap
+        * Keg
+    * Drink
+        * Keg
+        * Session

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Webb
+
+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,178 @@
+# KegbotApi
+
+[Kegbot](https://kegbot.org/) Server [REST API](https://kegbot.org/docs/api/) client implemented in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kegbot_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kegbot_api
+
+## Usage
+
+Using the `KegbotApi` is pretty straight-forward.
+
+### Example 1
+
+``` ruby
+require 'kegbot_api'
+
+#
+# Example use of the KegbotApi
+#
+
+client = KegbotApi::Client.new "http://demo.kegbot.org/api"
+
+puts "KegbotApi Demo"
+puts "http://demo.kegbot.org/api"
+puts "--------------"
+
+taps = client.Tap.all
+
+puts "Taps: #{taps.length}"
+puts "--------------"
+
+taps.each_with_index do |tap, index|
+  puts "Tap #{index + 1}"
+  puts tap.name
+  puts "Online? #{tap.online?}"
+
+  if tap.online?
+    puts "On Tap: #{tap.keg.name}"
+
+    puts "Remaining: #{tap.keg.volume_ml_remaining}ml of #{tap.keg.volume_ml}ml"
+    puts '%.0f%' % tap.keg.percent_full
+  end
+
+  puts "--------------"
+end
+
+# Or you can find resources by ID...for example: Keg 1
+
+puts "GET /kegs/1"
+tap = client.Keg.find(1)
+
+[:id, :name, :size_name, :volume_ml_remaining, :percent_full, :online?].each do |name|
+  puts "#{name} = #{tap.send(name)}"
+end
+```
+
+produces output:
+
+``` text
+KegbotApi Demo
+http://demo.kegbot.org/api
+--------------
+Taps: 2
+--------------
+Tap 1
+Main Tap
+Online? true
+On Tap: Drake's 1500
+Remaining: 21796.9ml of 58673.9ml
+37%
+--------------
+Tap 2
+Second Tap
+Online? true
+On Tap: Anchor Steam
+Remaining: 21005.9ml of 58673.9ml
+36%
+--------------
+GET /kegs/1
+id = 1
+name = Drake's Blonde
+size_name = half-barrel
+volume_ml_remaining = 80.90000000000146
+percent_full = 0.13788072720579586
+online? = false
+```
+
+Source is at [`spec/example_1.rb`](spec/example_1.rb)
+
+### Example 2
+
+``` ruby
+require 'kegbot_api'
+
+#
+# REST endpoints and their corresponding KegbotApi classes/methods
+#
+
+client = KegbotApi::Client.new "http://demo.kegbot.org/api"
+
+# /drinks
+client.Drink.all
+
+# /drinks/ID
+client.Drink.find(1)
+
+# /taps
+client.Tap.all
+
+# /kegs
+client.Keg.all
+
+# /kegs/ID
+client.Keg.find(1)
+
+# /sessions
+client.Session.all
+
+# /sessions/ID
+client.Session.find(1)
+```
+
+Source is at [`spec/example_2.rb`](spec/example_2.rb)
+
+
+For more examples, see the rspec test cases in the [`spec` directory](spec)
+
+## Limitations
+
+The [Kegbot Server REST API specification](https://kegbot.org/docs/api/) is in flux (as mentioned on the specification page).  As such, things might break.  Open an issue, or even better, a pull request!
+
+The Kegbot Server REST API specification is a bit out of date to what the server actually returns...as such, when in doubt, hit the REST URL directly and see what you see:  eg: http://demo.kegbot.org/api/taps
+
+Currently, the API is for unauthenticated and read-only content: `taps`, `kegs`, and `drinks` endpoints and their sub-objects `beverage`, `image`.  The following are not fully implemented yet:
+
+* GET `/taps/ID`
+* GET `/kegs/ID/drinks`
+* GET `/kegs/ID/sessions`
+* GET `/users`
+* GET `/users/ID`
+* GET `/users/ID/drinks`
+* GET `/users/ID/auth-tokens`
+* GET `/thermo-sensors`
+* All POST Endpoints
+
+That being said, the API is complete for querying most information from a Kegbot server.
+
+## Version History
+
+See [CHANGELOG.md](CHANGELOG.md) for a complete version history.
+
+## Branch Convention
+
+* `master`
+  * Latest stable version
+* `develop`
+  * Bleeding edge development
+* `wip*`
+  * Work in progress (WIP).  Should not be used unless you absolutely know what you're doing.
+
+## Contributing
+
+1. Fork it ( https://github.com/kegbot/kegbot_ruby_api/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/kegbot_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kegbot_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kegbot_api"
+  spec.version       = KegbotApi::VERSION
+  spec.authors       = ["Eric Webb"]
+  spec.email         = ["opensource@collectivegenius.net"]
+  spec.summary       = "Kegbot REST API implementation in Ruby"
+  spec.description   = "Kegbot REST API implementation in Ruby"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+      .reject { |path| path.match /\A\.idea\//  }     # Ignore .idea/ IntelliJ project directory
+      .reject { |path| path.match /\A[^\/]+\.iml/ }   # Ignore *.iml IntelliJ module file
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "wwtd"
+  spec.add_development_dependency "fakeweb", "~> 1.3"
+  spec.add_development_dependency "yard", "0.8.7.3"
+  spec.add_development_dependency "activesupport", "~> 4.0"
+end

data/lib/kegbot_api.rb

@@ -0,0 +1,7 @@
+require "kegbot_api/version"
+require "kegbot_api/errors"
+require "kegbot_api/client"
+
+module KegbotApi
+  # Your code goes here...
+end

data/lib/kegbot_api/client.rb

@@ -0,0 +1,39 @@
+require 'kegbot_api/client_helpers'
+require 'kegbot_api/nouns/keg'
+require 'kegbot_api/nouns/tap'
+require 'kegbot_api/nouns/drink'
+require 'kegbot_api/nouns/session'
+require 'kegbot_api/nouns/beverage'
+require 'kegbot_api/nouns/image'
+require 'kegbot_api/nouns/keg_size'
+
+module KegbotApi
+  # Represents a connection to a specific Kegbot REST server
+  #
+  # Because a program my want to access multiple Kegbot REST APIs servers from the same program, you can create a {Client}
+  # instance appropriate for each server.  To get an instance of a REST noun ({Drink}, {Keg}, {Tap}, etc.) connected to
+  # this client, use the appropriate methods below. {#Drink}
+  class Client
+    include ClientHelpers
+
+    attr_accessor :base_url
+
+    # @param base_url [String] base URL for the REST server (ie: http://demo.kegbot.org/api)
+    # @param options [Hash] (currently unused)
+    def initialize(base_url, options = {})
+      self.base_url = base_url
+    end
+
+    # @!macro [attach] rest_noun
+    #   @!method $1
+    #   @return [$1] $1 class (specialized for this specific client instance)
+    noun Drink
+    noun Tap
+    noun Keg
+    noun Session
+    noun Session
+    noun Beverage
+    noun Image
+    noun KegSize
+  end
+end

data/lib/kegbot_api/client_helpers.rb

@@ -0,0 +1,33 @@
+require 'active_support/concern'
+
+module KegbotApi
+  # Helper methods to be extended from {Client}
+  module ClientHelpers
+    extend ActiveSupport::Concern
+
+    # Returns RestNoun subclass by name
+    # @param [String, Symbol] noun name, ie: +Drink+, +Tap+
+    # @return [RestNoun] noun configured for this client
+    # @visibility private
+    def noun_class(name)
+      self.send(name)
+    end
+
+    module ClassMethods
+      # Creates a method with the same name as the specified `klass`, returning a new instance of the klass specialized
+      # for this {Client} instance.
+      # @param [Class] klass a class instance (ie: {Drink}, {Keg}, etc.)
+      # @visibility private
+      def noun(klass)
+        short_name = klass.name.split('::').last
+
+        define_method(short_name) do
+          klazz = klass.clone
+          klazz.client = self
+
+          klazz
+        end
+      end
+    end
+  end
+end

data/lib/kegbot_api/errors.rb

@@ -0,0 +1,17 @@
+module KegbotApi
+  # Base error of all KegbotApi errors
+  class Error < StandardError
+  end
+
+  # Raised when a feature isn't implemented
+  class NotImplementedError < Error
+  end
+
+  # Raises when a specific resource is not found
+  class NotFoundError < Error
+  end
+
+  # Raised when an input (user or server) isn't appropriate/expected.
+  class InvalidInputError < Error
+  end
+end

data/lib/kegbot_api/nouns/beverage.rb

@@ -0,0 +1,23 @@
+require 'kegbot_api/nouns/rest_noun'
+
+module KegbotApi
+  # Beverage information (as returned with a {Keg} instance)
+  class Beverage < RemoteRestNoun
+    id      :id
+    string  :name
+    float   :abv
+    has_one :image
+
+    def to_s
+      "#<#{self.class.to_s}:#{"0x%x" % object_id} @id=#{self.id.inspect}>"
+    end
+
+    def self.to_s
+      self.client ? "KegbotApi::Beverage<#{self.client.base_url}>" : super
+    end
+
+    def self.inspect
+      to_s
+    end
+  end
+end

data/lib/kegbot_api/nouns/drink.rb

@@ -0,0 +1,32 @@
+require 'kegbot_api/nouns/remote_rest_noun'
+
+module KegbotApi
+  class Drink < RemoteRestNoun
+    id      :id
+    float   :volume_ml
+    time    :time
+    integer :duration
+    has_one :keg
+    has_one :session
+
+    def self.all
+      list(get("#{self.client.base_url}/drinks"))
+    end
+
+    def self.find(id, *args)
+      one(get("#{self.client.base_url}/drinks/#{id}"))
+    end
+
+    def to_s
+      "#<#{self.class.to_s}:#{"0x%x" % object_id} @id=#{self.id.inspect}>"
+    end
+
+    def self.to_s
+      self.client ? "KegbotApi::Drink<#{self.client.base_url}>" : super
+    end
+
+    def self.inspect
+      to_s
+    end
+  end
+end