kegbot_api 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +24 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +9 -0
  5. data/.yardopts +1 -0
  6. data/CHANGELOG.md +18 -0
  7. data/Gemfile +4 -0
  8. data/LICENSE.txt +22 -0
  9. data/README.md +178 -0
  10. data/Rakefile +1 -0
  11. data/kegbot_api.gemspec +30 -0
  12. data/lib/kegbot_api.rb +7 -0
  13. data/lib/kegbot_api/client.rb +39 -0
  14. data/lib/kegbot_api/client_helpers.rb +33 -0
  15. data/lib/kegbot_api/errors.rb +17 -0
  16. data/lib/kegbot_api/nouns/beverage.rb +23 -0
  17. data/lib/kegbot_api/nouns/drink.rb +32 -0
  18. data/lib/kegbot_api/nouns/image.rb +22 -0
  19. data/lib/kegbot_api/nouns/keg.rb +45 -0
  20. data/lib/kegbot_api/nouns/keg_size.rb +21 -0
  21. data/lib/kegbot_api/nouns/remote_rest_noun.rb +49 -0
  22. data/lib/kegbot_api/nouns/rest_noun.rb +36 -0
  23. data/lib/kegbot_api/nouns/rest_noun_attributes.rb +119 -0
  24. data/lib/kegbot_api/nouns/session.rb +32 -0
  25. data/lib/kegbot_api/nouns/tap.rb +31 -0
  26. data/lib/kegbot_api/rest_response.rb +76 -0
  27. data/lib/kegbot_api/version.rb +3 -0
  28. data/spec/beverage_spec.rb +44 -0
  29. data/spec/drink_spec.rb +88 -0
  30. data/spec/drinks.http +5416 -0
  31. data/spec/drinks_614.http +68 -0
  32. data/spec/drinks_999999.http +18 -0
  33. data/spec/example_1.rb +40 -0
  34. data/spec/example_2.rb +28 -0
  35. data/spec/examples_spec.rb +37 -0
  36. data/spec/image_spec.rb +33 -0
  37. data/spec/keg_spec.rb +131 -0
  38. data/spec/kegs.http +144 -0
  39. data/spec/kegs_4.http +46 -0
  40. data/spec/kegs_999999.http +18 -0
  41. data/spec/session_spec.rb +73 -0
  42. data/spec/sessions.http +601 -0
  43. data/spec/sessions_65.http +23 -0
  44. data/spec/sessions_999999.http +18 -0
  45. data/spec/spec_helper.rb +34 -0
  46. data/spec/tap_spec.rb +134 -0
  47. data/spec/taps.http +96 -0
  48. metadata +209 -0
@@ -0,0 +1,23 @@
1
+ HTTP/1.1 200 OK
2
+ Server: nginx/1.4.1 (Ubuntu)
3
+ Date: Thu, 27 Feb 2014 00:45:51 GMT
4
+ Content-Type: application/json
5
+ Transfer-Encoding: chunked
6
+ Connection: close
7
+ Vary: Accept-Encoding
8
+ Cache-Control: max-age=0
9
+
10
+ {
11
+ "object": {
12
+ "name": "",
13
+ "url": "/sessions/2014/2/27/65/",
14
+ "start_time": "2014-02-27T00:08:15+00:00",
15
+ "volume_ml": 222.0,
16
+ "is_active": true,
17
+ "end_time": "2014-02-27T03:08:15+00:00",
18
+ "id": 65
19
+ },
20
+ "meta": {
21
+ "result": "ok"
22
+ }
23
+ }
@@ -0,0 +1,18 @@
1
+ HTTP/1.1 404 NOT FOUND
2
+ Server: nginx/1.4.1 (Ubuntu)
3
+ Date: Thu, 27 Feb 2014 23:58:38 GMT
4
+ Content-Type: application/json
5
+ Transfer-Encoding: chunked
6
+ Connection: close
7
+ Vary: Cookie
8
+ Cache-Control: max-age=0
9
+
10
+ {
11
+ "meta": {
12
+ "result": "error"
13
+ },
14
+ "error": {
15
+ "message": "No DrinkingSession matches the given query.",
16
+ "code": "NotFoundError"
17
+ }
18
+ }
@@ -0,0 +1,34 @@
1
+ require 'kegbot_api'
2
+ require 'fakeweb'
3
+
4
+ TEST_API_BASEURL = "https://example.kegbot.org/api"
5
+
6
+ # This file was generated by the `rspec --init` command. Conventionally, all
7
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
8
+ # Require this file using `require "spec_helper"` to ensure that it is only
9
+ # loaded once.
10
+ #
11
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
12
+ RSpec.configure do |config|
13
+ config.treat_symbols_as_metadata_keys_with_true_values = true
14
+ config.run_all_when_everything_filtered = true
15
+ config.filter_run :focus
16
+
17
+ # Run specs in random order to surface order dependencies. If you find an
18
+ # order dependency and want to debug it, you can fix the order by providing
19
+ # the seed, which is printed after each run.
20
+ # --seed 1234
21
+ config.order = 'random'
22
+ end
23
+
24
+ FakeWeb.allow_net_connect = false
25
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/taps", :response => File.join(File.dirname(__FILE__), "taps.http"))
26
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/kegs", :response => File.join(File.dirname(__FILE__), "kegs.http"))
27
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/kegs/4", :response => File.join(File.dirname(__FILE__), "kegs_4.http"))
28
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/kegs/999999", :response => File.join(File.dirname(__FILE__), "kegs_999999.http"))
29
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/drinks", :response => File.join(File.dirname(__FILE__), "drinks.http"))
30
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/drinks/614", :response => File.join(File.dirname(__FILE__), "drinks_614.http"))
31
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/drinks/999999", :response => File.join(File.dirname(__FILE__), "drinks_999999.http"))
32
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/sessions", :response => File.join(File.dirname(__FILE__), "sessions.http"))
33
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/sessions/65", :response => File.join(File.dirname(__FILE__), "sessions_65.http"))
34
+ FakeWeb.register_uri(:get, "#{TEST_API_BASEURL}/sessions/999999", :response => File.join(File.dirname(__FILE__), "sessions_999999.http"))
@@ -0,0 +1,134 @@
1
+ require 'spec_helper'
2
+
3
+ describe KegbotApi::Tap do
4
+ let(:client) { KegbotApi::Client.new TEST_API_BASEURL }
5
+ let(:attributes) do
6
+ {
7
+ "meter_name" => "kegboard.flow0",
8
+ "name" => "Main Tap",
9
+ "ml_per_tick" => 0.185185185185185,
10
+ "relay_name" => "",
11
+ "current_keg" => {
12
+ "volume_ml_remain" => 21796.9,
13
+ "type_id" => "4",
14
+ "url" => "/kegs/4",
15
+ "spilled_ml" => 0.0,
16
+ "start_time" => "2014-01-31T23:11:42+00:00",
17
+ "percent_full" => 37.149226487416044,
18
+ "id" => 4, "size_name" =>
19
+ "half-barrel",
20
+ "end_time" => "2014-01-31T23:11:42+00:00",
21
+ "online" => true,
22
+ "type" => {
23
+ "name" => "Drake's 1500",
24
+ "style_id" => "0",
25
+ "image" => {
26
+ "url" => "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg",
27
+ "thumbnail_url" => "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg",
28
+ "time" => "2014-01-31T23:10:53+00:00",
29
+ "original_url" => "/media/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90.e"
30
+ },
31
+ "abv" => 0.0,
32
+ "brewer_id" => "3",
33
+ "id" => "4"
34
+ },
35
+ "size_id" => 0,
36
+ "size_volume_ml" => 58673.9,
37
+ "size" => {
38
+ "volume_ml" => 58673.9,
39
+ "id" => 0,
40
+ "name" => "half-barrel"
41
+ }
42
+ },
43
+ "current_keg_id" => 4,
44
+ "id" => 1
45
+ }
46
+ end
47
+ let(:attributes2) do
48
+ cloned = attributes
49
+ cloned['current_keg']['online'] = false
50
+
51
+ cloned
52
+ end
53
+ subject { client.Tap.new attributes }
54
+
55
+ describe "Class Methods" do
56
+ let(:all) { client.Tap.all }
57
+
58
+ describe "::all" do
59
+ describe "Is Array Like" do
60
+ it "responds_to length" do
61
+ expect(all).to respond_to :length
62
+ end
63
+
64
+ it "responds_to []" do
65
+ expect(all).to respond_to :[]
66
+ end
67
+ end
68
+
69
+ it "length == 2" do
70
+ expect(all.length).to eq 2
71
+ end
72
+
73
+ it "first.id == 1" do
74
+ expect(all.first.id).to eq 1
75
+ end
76
+ end
77
+ end
78
+
79
+ describe "Instance Methods" do
80
+ describe "Example 1" do
81
+ it "id == 1" do
82
+ expect(subject.id).to eq 1
83
+ end
84
+
85
+ it "name == 'Main Tap'" do
86
+ expect(subject.name).to eq 'Main Tap'
87
+ end
88
+
89
+ it "meter_name == ''" do
90
+ expect(subject.meter_name).to eq 'kegboard.flow0'
91
+ end
92
+
93
+ it "ml_per_tick == '0.185185185185185'" do
94
+ expect(subject.ml_per_tick).to be_within(1e-6).of(0.185185185185185)
95
+ end
96
+
97
+ it "online? == true" do
98
+ expect(subject.online?).to be true
99
+ end
100
+
101
+ it "to_s containts 'KegbotApi::Tap'" do
102
+ expect(subject.to_s).to include 'KegbotApi::Tap'
103
+ end
104
+ end
105
+
106
+ describe "Example 2" do
107
+ subject { client.Tap.new attributes2 }
108
+
109
+ it "online? == false" do
110
+ expect(subject.online?).to be false
111
+ end
112
+ end
113
+ end
114
+
115
+ describe "Associations" do
116
+ subject { client.Tap.first }
117
+
118
+ describe "keg" do
119
+ it "Returns a Keg" do
120
+ expect(subject.keg).to_not be nil
121
+ end
122
+
123
+ it "keg.id == 4" do
124
+ expect(subject.keg.id).to eq 4
125
+ end
126
+
127
+ it "current_keg also works" do
128
+ expect(subject.current_keg.id).to eq 4
129
+ end
130
+ end
131
+ end
132
+
133
+ pending "tap.find"
134
+ end
@@ -0,0 +1,96 @@
1
+ HTTP/1.1 200 OK
2
+ Server: nginx/1.4.1 (Ubuntu)
3
+ Date: Thu, 27 Feb 2014 00:24:20 GMT
4
+ Content-Type: application/json
5
+ Transfer-Encoding: chunked
6
+ Connection: close
7
+ Vary: Accept-Encoding
8
+ Cache-Control: max-age=0
9
+
10
+ {
11
+ "objects": [
12
+ {
13
+ "meter_name": "kegboard.flow0",
14
+ "name": "Main Tap",
15
+ "ml_per_tick": 0.185185185185185,
16
+ "relay_name": "",
17
+ "current_keg": {
18
+ "volume_ml_remain": 21796.9,
19
+ "type_id": "4",
20
+ "url": "/kegs/4",
21
+ "spilled_ml": 0.0,
22
+ "start_time": "2014-01-31T23:11:42+00:00",
23
+ "percent_full": 37.149226487416044,
24
+ "id": 4,
25
+ "size_name": "half-barrel",
26
+ "end_time": "2014-01-31T23:11:42+00:00",
27
+ "online": true,
28
+ "type": {
29
+ "name": "Drake's 1500",
30
+ "style_id": "0",
31
+ "image": {
32
+ "url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/0d8521a4eef37663218db5aef284089e.jpg",
33
+ "thumbnail_url": "/media/CACHE/images/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90/1c3f0a2375704ebe62a82aec658b5287.jpg",
34
+ "time": "2014-01-31T23:10:53+00:00",
35
+ "original_url": "/media/pics/20140131231053-e6ce61eda0a841edad856fe2679c8f90.e"
36
+ },
37
+ "abv": 0.0,
38
+ "brewer_id": "3",
39
+ "id": "4"
40
+ },
41
+ "size_id": 0,
42
+ "size_volume_ml": 58673.9,
43
+ "size": {
44
+ "volume_ml": 58673.9,
45
+ "id": 0,
46
+ "name": "half-barrel"
47
+ }
48
+ },
49
+ "current_keg_id": 4,
50
+ "id": 1
51
+ },
52
+ {
53
+ "meter_name": "kegboard.flow1",
54
+ "name": "Second Tap",
55
+ "ml_per_tick": 0.185185185185185,
56
+ "relay_name": "",
57
+ "current_keg": {
58
+ "volume_ml_remain": 21005.9,
59
+ "type_id": "1",
60
+ "url": "/kegs/3",
61
+ "spilled_ml": 0.0,
62
+ "start_time": "2014-01-31T23:11:38+00:00",
63
+ "percent_full": 35.80109725107757,
64
+ "id": 3,
65
+ "size_name": "half-barrel",
66
+ "end_time": "2014-01-31T23:11:38+00:00",
67
+ "online": true,
68
+ "type": {
69
+ "name": "Anchor Steam",
70
+ "style_id": "0",
71
+ "image": {
72
+ "url": "/media/CACHE/images/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0/c7a226b5122af9ea4c3b9d72cdc4c46d.jpg",
73
+ "thumbnail_url": "/media/CACHE/images/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0/704675543d5b73232c8a51f16435ea9d.jpg",
74
+ "time": "2014-01-31T23:10:53+00:00",
75
+ "original_url": "/media/pics/20140131231053-a36a6b7cd54d461c97c63339c6762bf0.e"
76
+ },
77
+ "abv": 0.0,
78
+ "brewer_id": "1",
79
+ "id": "1"
80
+ },
81
+ "size_id": 0,
82
+ "size_volume_ml": 58673.9,
83
+ "size": {
84
+ "volume_ml": 58673.9,
85
+ "id": 0,
86
+ "name": "half-barrel"
87
+ }
88
+ },
89
+ "current_keg_id": 3,
90
+ "id": 2
91
+ }
92
+ ],
93
+ "meta": {
94
+ "result": "ok"
95
+ }
96
+ }
metadata ADDED
@@ -0,0 +1,209 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kegbot_api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Eric Webb
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-02-28 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.5'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.5'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ~>
46
+ - !ruby/object:Gem::Version
47
+ version: '2.14'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ~>
53
+ - !ruby/object:Gem::Version
54
+ version: '2.14'
55
+ - !ruby/object:Gem::Dependency
56
+ name: wwtd
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: fakeweb
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ~>
74
+ - !ruby/object:Gem::Version
75
+ version: '1.3'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ~>
81
+ - !ruby/object:Gem::Version
82
+ version: '1.3'
83
+ - !ruby/object:Gem::Dependency
84
+ name: yard
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - '='
88
+ - !ruby/object:Gem::Version
89
+ version: 0.8.7.3
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - '='
95
+ - !ruby/object:Gem::Version
96
+ version: 0.8.7.3
97
+ - !ruby/object:Gem::Dependency
98
+ name: activesupport
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ~>
102
+ - !ruby/object:Gem::Version
103
+ version: '4.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ~>
109
+ - !ruby/object:Gem::Version
110
+ version: '4.0'
111
+ description: Kegbot REST API implementation in Ruby
112
+ email:
113
+ - opensource@collectivegenius.net
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - .gitignore
119
+ - .rspec
120
+ - .travis.yml
121
+ - .yardopts
122
+ - CHANGELOG.md
123
+ - Gemfile
124
+ - LICENSE.txt
125
+ - README.md
126
+ - Rakefile
127
+ - kegbot_api.gemspec
128
+ - lib/kegbot_api.rb
129
+ - lib/kegbot_api/client.rb
130
+ - lib/kegbot_api/client_helpers.rb
131
+ - lib/kegbot_api/errors.rb
132
+ - lib/kegbot_api/nouns/beverage.rb
133
+ - lib/kegbot_api/nouns/drink.rb
134
+ - lib/kegbot_api/nouns/image.rb
135
+ - lib/kegbot_api/nouns/keg.rb
136
+ - lib/kegbot_api/nouns/keg_size.rb
137
+ - lib/kegbot_api/nouns/remote_rest_noun.rb
138
+ - lib/kegbot_api/nouns/rest_noun.rb
139
+ - lib/kegbot_api/nouns/rest_noun_attributes.rb
140
+ - lib/kegbot_api/nouns/session.rb
141
+ - lib/kegbot_api/nouns/tap.rb
142
+ - lib/kegbot_api/rest_response.rb
143
+ - lib/kegbot_api/version.rb
144
+ - spec/beverage_spec.rb
145
+ - spec/drink_spec.rb
146
+ - spec/drinks.http
147
+ - spec/drinks_614.http
148
+ - spec/drinks_999999.http
149
+ - spec/example_1.rb
150
+ - spec/example_2.rb
151
+ - spec/examples_spec.rb
152
+ - spec/image_spec.rb
153
+ - spec/keg_spec.rb
154
+ - spec/kegs.http
155
+ - spec/kegs_4.http
156
+ - spec/kegs_999999.http
157
+ - spec/session_spec.rb
158
+ - spec/sessions.http
159
+ - spec/sessions_65.http
160
+ - spec/sessions_999999.http
161
+ - spec/spec_helper.rb
162
+ - spec/tap_spec.rb
163
+ - spec/taps.http
164
+ homepage: ''
165
+ licenses:
166
+ - MIT
167
+ metadata: {}
168
+ post_install_message:
169
+ rdoc_options: []
170
+ require_paths:
171
+ - lib
172
+ required_ruby_version: !ruby/object:Gem::Requirement
173
+ requirements:
174
+ - - '>='
175
+ - !ruby/object:Gem::Version
176
+ version: '0'
177
+ required_rubygems_version: !ruby/object:Gem::Requirement
178
+ requirements:
179
+ - - '>='
180
+ - !ruby/object:Gem::Version
181
+ version: '0'
182
+ requirements: []
183
+ rubyforge_project:
184
+ rubygems_version: 2.0.14
185
+ signing_key:
186
+ specification_version: 4
187
+ summary: Kegbot REST API implementation in Ruby
188
+ test_files:
189
+ - spec/beverage_spec.rb
190
+ - spec/drink_spec.rb
191
+ - spec/drinks.http
192
+ - spec/drinks_614.http
193
+ - spec/drinks_999999.http
194
+ - spec/example_1.rb
195
+ - spec/example_2.rb
196
+ - spec/examples_spec.rb
197
+ - spec/image_spec.rb
198
+ - spec/keg_spec.rb
199
+ - spec/kegs.http
200
+ - spec/kegs_4.http
201
+ - spec/kegs_999999.http
202
+ - spec/session_spec.rb
203
+ - spec/sessions.http
204
+ - spec/sessions_65.http
205
+ - spec/sessions_999999.http
206
+ - spec/spec_helper.rb
207
+ - spec/tap_spec.rb
208
+ - spec/taps.http
209
+ has_rdoc: