phant_rb 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10b0b93f2d3e0ecf0156d9855314d061ad4b95c5
-  data.tar.gz: b0a06bb1fddcfe2c31564906224a265b9b2c877d
+  metadata.gz: 17838ed9df5576d26e9c8ce00811e647f5edc3d5
+  data.tar.gz: 2f61e56fb9dc21398b4d98cacaca28a31a249c47
 SHA512:
-  metadata.gz: d744866ff8a10dd7ca40fb277ddf251fc60b489c5550f1bf35637ae52c34384f720f59a0546510c3675392f8236131046685c06d76c85ac05664cfc9e9c5180b
-  data.tar.gz: 7fd43f00029bab1962cc66c2f0512d57ea8a106f3afd398ae9e9d6c4543b7d67198193f20a41726389123fe7407ecf3ec9b40f3b42490e607a9aa29cf4ebc024
+  metadata.gz: 351f3e77f750359d37bab877344284ddb828c9070422f79d18e7353b50b330262387b22b27118aa52633e80cce195e345f9f33ed8d7aebe38aaeaae23a39a3a5
+  data.tar.gz: dde8cd909d22e1da291b7edace160fdb2f2621d2dd69c19aad4a16d213e66b5f635a3f0292f5987f9c7a0cccbfa103e9b6b738a03d221362a7c272e2eeed543f

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby client for Phant. See [data.sparkfun.com](https://data.sparkfun.com/) for more information.
 
-This is a work in progress.
+[![Gem Version](https://badge.fury.io/rb/phant_rb.png)](http://badge.fury.io/rb/phant_rb)
 
 ## Installation
 
@@ -22,19 +22,53 @@ Or install it yourself as:
 
 ```ruby
 client = PhantRb::Client.new "PUBLIC_KEY", %w(humidity temp), private_key: 'PRIVATE_KEY'
+
+# log data, http://phant.io/docs/input/http/
 client.log(22.7, 17.8)
 
+# retrieve your data, http://phant.io/docs/output/http/
 data = client.get()
 puts data
+
+# retrieve info about the current state of your stream, http://phant.io/docs/output/stats/
+stats = client.stats()
+puts stats.pageCount
+puts stats.remaining
+
+# retrieve rate limit for the current stream, http://phant.io/docs/input/limit/
+# must be called only after PhantRb::Client#log is called
+limits = client.rate_limits()
+puts limits.x_rate_limit_remaining
+
+# clear all logged data from a stream, http://phant.io/docs/management/clear/
+client.clear()
+
+```
+
+To use different Phant server
+
+```ruby
+client = PhantRb::Client.new "PUBLIC_KEY", %w(humidity temp), {private_key: 'PRIVATE_KEY', base_url: 'http://127.0.0.1/'}
 ```
 
+## TODO
+* delete a stream
+* paginate data
+* use local server in specs
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/phant_rb/fork )
+1. Fork it ( https://github.com/girishso/phant_rb/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 a new Pull Request
 
+## Licence
+
+MIT License
+
+This software is provided as is, use it your own risk.
 
+Brought to you by: [Cube Root Software](http://www.cuberoot.in) (c) 2014
 

data/lib/phant_rb/version.rb

@@ -1,3 +1,3 @@
 module PhantRb
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/phant_rb.rb

@@ -14,23 +14,44 @@ module PhantRb
     end
 
     def log(*data)
-      @last_response = request data
+      conn = rest_conn 'input'
+      @last_response = conn.post URI.encode_www_form(@fields.zip(data))
       Hashie::Mash.new(JSON.parse(@last_response.body))
     end
 
     def get
-      @last_response = RestClient.get @opts[:base_url] + "output/" + @public_key + ".json",
-           'Phant-Private-Key' => @opts[:private_key]
-      JSON.parse @last_response.body
+      conn = rest_conn 'output'
+      response = conn.get
+      JSON.parse response.body
+    end
+
+    def stats
+      conn = rest_conn 'stats'
+      response = conn.get
+      Hashie::Mash.new(JSON.parse(response.body))
+    end
+
+    def clear
+      conn = rest_conn 'input'
+      response = conn.delete
+      Hashie::Mash.new(JSON.parse(response.body))
+    end
+
+    def rate_limits
+      unless !@last_response.nil? && @last_response.headers.has_key?(:x_rate_limit_remaining)
+        raise "No rate limit headers found. PhantRb::Client#log must be called before this."
+      end
+      Hashie::Mash.new(@last_response.headers)
     end
 
     private
-      def request(data)
-        RestClient.post(
-           @opts[:base_url] + "input/" + @public_key + ".json",
-           URI.encode_www_form(@fields.zip(data)),
-           'Phant-Private-Key' => @opts[:private_key]
-        )
+      def rest_conn(type)
+        url = case type
+              when 'stats' then URI.join @opts[:base_url], "/output/", "#{@public_key}/stats.json"
+              else  URI.join @opts[:base_url], "/#{type}/", "#{@public_key}.json"
+              end
+        RestClient::Resource.new url.to_s,
+          {:headers => {'Phant-Private-Key' => @opts[:private_key]}}
       end
   end
 end

data/spec/phant_rb_spec.rb

@@ -10,12 +10,28 @@ describe PhantRb do
     expect(resp.success).to be true
   end
 
-  it 'reads data' do
+  it 'returns rate limits' do
+    resp = @client.log(12.0, 23)
     @client.get
+    resp = @client.rate_limits
+    expect(resp.has_key?(:x_rate_limit_remaining)).to be true
+  end
+
+  it 'reads data' do
+    resp = @client.get
+    expect(resp).to be_an(Array)
+  end
+
+  it 'returns stats for a stream' do
+    resp = @client.stats
+    expect(resp.has_key?(:remaining)).to be true
+  end
+
+
+  it 'clears a stream' do
+    resp = @client.clear
+    expect(resp.success).to be true
   end
 
   it 'completely deletes a stream'
-  it 'clears a stream'
-  it 'returns stats for a stream'
-  it 'returns rate limits'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phant_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Girish S
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client