kegbot_api 0.0.1

data/spec/drinks_614.http

@@ -0,0 +1,68 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.1 (Ubuntu)
+Date: Thu, 27 Feb 2014 00:29:34 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: close
+Vary: Accept-Encoding
+Cache-Control: max-age=0
+
+{
+  "object": {
+    "ticks": 0, 
+    "user_id": "harry", 
+    "url": "/drinks/614", 
+    "duration": 0, 
+    "volume_ml": 222.0, 
+    "session_id": 65, 
+    "keg": {
+      "volume_ml_remain": 21005.9, 
+      "type_id": "1", 
+      "url": "/kegs/3", 
+      "spilled_ml": 0.0, 
+      "start_time": "2014-01-31T23:11:38+00:00", 
+      "percent_full": 35.80109725107757, 
+      "id": 3, 
+      "size_name": "half-barrel", 
+      "end_time": "2014-01-31T23:11:38+00:00", 
+      "online": true, 
+      "size_id": 0, 
+      "size_volume_ml": 58673.9
+    }, 
+    "session": {
+      "name": "", 
+      "url": "/sessions/2014/2/27/65/", 
+      "start_time": "2014-02-27T00:08:15+00:00", 
+      "volume_ml": 222.0, 
+      "end_time": "2014-02-27T03:08:15+00:00", 
+      "id": 65
+    }, 
+    "user": {
+      "username": "harry", 
+      "url": "/drinkers/harry/", 
+      "image": {
+        "url": "/media/CACHE/images/pics/20140131231053-940cdc69ae8a495c960ea8ed893f3c8f/580d339d579ee75ce42f46e4c2334e2f.jpg", 
+        "thumbnail_url": "/media/CACHE/images/pics/20140131231053-940cdc69ae8a495c960ea8ed893f3c8f/f72092fa383a61a40f2349d8aee2c075.jpg", 
+        "user_id": "harry", 
+        "time": "2014-01-31T23:10:53+00:00", 
+        "original_url": "/media/pics/20140131231053-940cdc69ae8a495c960ea8ed893f3c8f.e"
+      }, 
+      "is_active": true
+    }, 
+    "time": "2014-02-27T00:08:15+00:00", 
+    "images": [
+      {
+        "url": "/media/CACHE/images/pics/20140131231108-1cf7756d878e42f99f2e2918beb06d32/dcf6beaf3cb512cc6aa638a007988d15.jpg", 
+        "thumbnail_url": "/media/CACHE/images/pics/20140131231108-1cf7756d878e42f99f2e2918beb06d32/38a46c4a8e786bc33de1bbabba514440.jpg", 
+        "user_id": "harry", 
+        "time": "2014-02-27T00:08:15+00:00", 
+        "original_url": "/media/pics/20140131231108-1cf7756d878e42f99f2e2918beb06d32.7"
+      }
+    ], 
+    "keg_id": 3, 
+    "id": 614
+  }, 
+  "meta": {
+    "result": "ok"
+  }
+}

data/spec/drinks_999999.http

@@ -0,0 +1,18 @@
+HTTP/1.1 404 NOT FOUND
+Server: nginx/1.4.1 (Ubuntu)
+Date: Thu, 27 Feb 2014 23:05:37 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: close
+Vary: Cookie
+Cache-Control: max-age=0
+
+{
+  "meta": {
+    "result": "error"
+  }, 
+  "error": {
+    "message": "No Drink matches the given query.", 
+    "code": "NotFoundError"
+  }
+}

data/spec/example_1.rb

@@ -0,0 +1,40 @@
+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

data/spec/example_2.rb

@@ -0,0 +1,28 @@
+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)

data/spec/examples_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "Example Use Cases" do
+  let(:default_baseurl) { TEST_API_BASEURL }
+  let(:client) { KegbotApi::Client.new default_baseurl }
+
+  it "Multiple Concurrent Clients" do
+    client_1_baseurl = "https://example1.kegbot.org/api"
+    client_2_baseurl = "https://example2.kegbot.org/api"
+
+    client1 = KegbotApi::Client.new client_1_baseurl
+    client2 = KegbotApi::Client.new client_2_baseurl
+
+    # Each Tap class should have a baseurl based on the client
+    expect(client1.Tap.client.base_url).to eq client_1_baseurl
+    expect(client2.Tap.client.base_url).to eq client_2_baseurl
+  end
+
+  describe "Example Scripts" do
+    before(:each) { FakeWeb.allow_net_connect = %r[^https?://demo\.kegbot\.org/api] }
+    after(:each) { FakeWeb.allow_net_connect = nil }
+
+    it "example_1.rb" do
+      script = File.join(File.dirname(__FILE__), "example_1.rb")
+      ruby = File.read(script)
+
+      Kernel::eval(ruby, nil, script)
+    end
+
+    it "example_2.rb" do
+      script = File.join(File.dirname(__FILE__), "example_2.rb")
+      ruby = File.read(script)
+
+      Kernel::eval(ruby, nil, script)
+    end
+  end
+end

data/spec/image_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe KegbotApi::Image do
+  let(:client) { KegbotApi::Client.new TEST_API_BASEURL }
+  let(:attributes) do
+    {
+        "url" => "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg",
+        "thumbnail_url" => "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg",
+        "original_url" => "/media/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90.e",
+        "time" => "2014-01-31T23:10:53+00:00"
+    }
+  end
+
+  describe "Image Methods" do
+    subject { client.Image.new attributes }
+
+    it "time" do
+      expect(subject.time).to eq DateTime.iso8601("2014-01-31T23:10:53+00:00").to_time
+    end
+
+    it "url" do
+      expect(subject.url).to eq 'https://example.kegbot.org/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg'
+    end
+
+    it "thumbnail_url" do
+      expect(subject.thumbnail_url).to eq 'https://example.kegbot.org/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg'
+    end
+
+    it "to_s container 'KegbotApi::Image'" do
+      expect(subject.to_s).to include 'KegbotApi::Image'
+    end
+  end
+end

data/spec/keg_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe KegbotApi::Keg do
+  let(:client) { KegbotApi::Client.new TEST_API_BASEURL }
+
+  describe "Class Methods" do
+    let(:all) { client.Keg.all }
+
+    describe "::all" do
+      describe "Is Array Like" do
+        it "responds_to length" do
+          expect(all).to respond_to :length
+        end
+
+        it "responds_to []" do
+          expect(all).to respond_to :[]
+        end
+      end
+
+      it "length == 4" do
+        expect(all.length).to eq 4
+      end
+
+      it "first.id == 4" do
+        expect(all.first.id).to eq 4
+      end
+    end
+
+    describe "::find(4)" do
+      subject { client.Keg.find 4 }
+
+      it "Succeeds" do
+        expect(subject).to_not be nil
+      end
+
+      it "id == 4" do
+        expect(subject.id).to eq 4
+      end
+
+      it "raise NotFoundError on invalid ID" do
+        expect { client.Keg.find 999999 }.to raise_error(KegbotApi::NotFoundError)
+      end
+    end
+  end
+
+  describe "Instance Methods" do
+    subject { client.Keg.first }
+
+    it "id == 4" do
+      expect(subject.id).to eq 4
+    end
+
+    it "percent_full == 37.149226487416044" do
+      expect(subject.percent_full).to be_within(1e-6).of 37.149226487416044
+    end
+
+    it "volume_ml_remain == 21796.9" do
+      expect(subject.volume_ml_remain).to be_within(1e-6).of 21796.9
+      expect(subject.volume_ml_remaining).to be_within(1e-6).of 21796.9
+    end
+
+    it "spilled_ml == 0.0" do
+      expect(subject.spilled_ml).to be_within(1e-6).of 0.0
+    end
+
+    it "start_time == '2014-01-31T23:11:42+00:00'" do
+      expect(subject.start_time).to eq DateTime.iso8601('2014-01-31T23:11:42+00:00').to_time
+    end
+
+    it "start_time is Time" do
+      expect(subject.start_time).to be_kind_of Time
+    end
+
+    it "end_time == '2014-01-31T23:11:42+00:00'" do
+      expect(subject.end_time).to eq DateTime.iso8601('2014-01-31T23:11:42+00:00').to_time
+    end
+
+    it "end_time is Time" do
+      expect(subject.end_time).to be_kind_of Time
+    end
+
+    it "online? == true" do
+      expect(subject).to be_online
+    end
+
+    it "name == 'Drake's 1500'" do
+      expect(subject.name).to eq "Drake's 1500"
+    end
+
+    it "volume_ml == 58673.9" do
+      expect(subject.volume_ml).to eq 58673.9
+    end
+
+    it "size_name == 'half-barrel'" do
+      expect(subject.size_name).to eq "half-barrel"
+    end
+
+    it "to_s containts 'KegbotApi::Keg'" do
+      expect(subject.to_s).to include 'KegbotApi::Keg'
+    end
+  end
+
+  describe "Associations" do
+    describe "type/beverage" do
+      subject { client.Keg.first }
+
+      it "Works" do
+        expect(subject.beverage).to_not be nil
+      end
+
+      it "aka type" do
+        expect(subject.type).to_not be nil
+      end
+
+      it "beverage.name" do
+        expect(subject.beverage.name).to_not be nil
+      end
+    end
+
+    describe "size" do
+      subject { client.Keg.first }
+
+      it "Works" do
+        expect(subject.size).to_not be nil
+      end
+    end
+  end
+
+  pending "keg.drinks"
+  pending "keg.sessions"
+end

data/spec/kegs.http

@@ -0,0 +1,144 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.1 (Ubuntu)
+Date: Thu, 27 Feb 2014 00:24:53 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: close
+Vary: Accept-Encoding
+Cache-Control: max-age=0
+
+{
+  "objects": [
+    {
+      "volume_ml_remain": 21796.9, 
+      "type_id": "4", 
+      "url": "/kegs/4", 
+      "spilled_ml": 0.0, 
+      "start_time": "2014-01-31T23:11:42+00:00", 
+      "percent_full": 37.149226487416044, 
+      "size_id": 0, 
+      "size_name": "half-barrel", 
+      "end_time": "2014-01-31T23:11:42+00:00", 
+      "online": true, 
+      "type": {
+        "name": "Drake's 1500", 
+        "style_id": "0", 
+        "image": {
+          "url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg", 
+          "thumbnail_url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg", 
+          "original_url": "/media/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90.e", 
+          "time": "2014-01-31T23:10:53+00:00"
+        }, 
+        "abv": 0.0, 
+        "brewer_id": "3", 
+        "id": "4"
+      }, 
+      "id": 4, 
+      "size_volume_ml": 58673.9, 
+      "size": {
+        "volume_ml": 58673.9, 
+        "id": 0, 
+        "name": "half-barrel"
+      }
+    }, 
+    {
+      "volume_ml_remain": 21005.9, 
+      "type_id": "1", 
+      "url": "/kegs/3", 
+      "spilled_ml": 0.0, 
+      "start_time": "2014-01-31T23:11:38+00:00", 
+      "percent_full": 35.80109725107757, 
+      "size_id": 0, 
+      "size_name": "half-barrel", 
+      "end_time": "2014-01-31T23:11:38+00:00", 
+      "online": true, 
+      "type": {
+        "name": "Anchor Steam", 
+        "style_id": "0", 
+        "image": {
+          "url": "/media/CACHE/images/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0/c7a226b5122af9ea4c3b9d72cdc4c46d.jpg", 
+          "thumbnail_url": "/media/CACHE/images/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0/704675543d5b73232c8a51f16435ea9d.jpg", 
+          "original_url": "/media/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0.e", 
+          "time": "2014-01-31T23:10:53+00:00"
+        }, 
+        "abv": 0.0, 
+        "brewer_id": "1", 
+        "id": "1"
+      }, 
+      "id": 3, 
+      "size_volume_ml": 58673.9, 
+      "size": {
+        "volume_ml": 58673.9, 
+        "id": 0, 
+        "name": "half-barrel"
+      }
+    }, 
+    {
+      "volume_ml_remain": 173.90000000000146, 
+      "type_id": "4", 
+      "url": "/kegs/2", 
+      "spilled_ml": 0.0, 
+      "start_time": "2013-12-18T20:49:00+00:00", 
+      "percent_full": 0.29638391175633705, 
+      "size_id": 0, 
+      "size_name": "half-barrel", 
+      "end_time": "2014-01-31T23:10:53+00:00", 
+      "online": false, 
+      "type": {
+        "name": "Drake's 1500", 
+        "style_id": "0", 
+        "image": {
+          "url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg", 
+          "thumbnail_url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg", 
+          "original_url": "/media/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90.e", 
+          "time": "2014-01-31T23:10:53+00:00"
+        }, 
+        "abv": 0.0, 
+        "brewer_id": "3", 
+        "id": "4"
+      }, 
+      "id": 2, 
+      "size_volume_ml": 58673.9, 
+      "size": {
+        "volume_ml": 58673.9, 
+        "id": 0, 
+        "name": "half-barrel"
+      }
+    }, 
+    {
+      "volume_ml_remain": 80.90000000000146, 
+      "type_id": "3", 
+      "url": "/kegs/1", 
+      "spilled_ml": 0.0, 
+      "start_time": "2013-12-18T20:10:00+00:00", 
+      "percent_full": 0.13788072720579586, 
+      "size_id": 0, 
+      "size_name": "half-barrel", 
+      "end_time": "2014-01-31T23:10:53+00:00", 
+      "online": false, 
+      "type": {
+        "name": "Drake's Blonde", 
+        "style_id": "0", 
+        "image": {
+          "url": "/media/CACHE/images/pics/20140131231053-5b277158667f4f34a63b6a4d627fbc02/50783fc343a86611edcea5ff3e196f8f.jpg", 
+          "thumbnail_url": "/media/CACHE/images/pics/20140131231053-5b277158667f4f34a63b6a4d627fbc02/da13742b4a6747654131b79ac261a3ef.jpg", 
+          "original_url": "/media/pics/20140131231053-5b277158667f4f34a63b6a4d627fbc02.e", 
+          "time": "2014-01-31T23:10:53+00:00"
+        }, 
+        "abv": 0.0, 
+        "brewer_id": "3", 
+        "id": "3"
+      }, 
+      "id": 1, 
+      "size_volume_ml": 58673.9, 
+      "size": {
+        "volume_ml": 58673.9, 
+        "id": 0, 
+        "name": "half-barrel"
+      }
+    }
+  ], 
+  "meta": {
+    "result": "ok"
+  }
+}