quanto-ruby 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3bc0b6091f0bdc8e5817acfec8620fa99e5cbc
-  data.tar.gz: e72e1010d853895ee9ec8d888d1417edb79683fb
+  metadata.gz: e07a8c9fabe39d67a1e2387f58820c20901a1d0c
+  data.tar.gz: 6bb185d1c3b7e8a9d373da65dc4d3a4d793e560f
 SHA512:
-  metadata.gz: 6a7724aa0dec3e3de0b0da0e5b441fbea218ab4ef328a143ab08b11e67126ba2b3995804261afd7d87cf66fe60543e24447024c9c286a12da25a8c76946fb47b
-  data.tar.gz: fbe00af13ce32d630f49d189f4545fd6fd2ccdc973b9969129479e073b8d3c4d1556809aaf79e003efe0c6d2cad869a096628372c4643d30112e17495dacf5b2
+  metadata.gz: c6ad8460d627d1a322a6d015edcc88b033d85ae331049096c3c3ab0f1aeaad5aa6a2402948730258f8684257a60cb9d5465ba2fc8b32743b3e7aa2c7781ad9dc
+  data.tar.gz: 2c4a2c30ff04624b59e8f4cda678c92ea0829ede57bc17e71e77074dddc65215eb9d646321cb924034bf96a4096a19e117ac398794b87cc7eefd2da4a1d69834

data/README.md

@@ -1,7 +1,5 @@
 # Quanto::Ruby
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,14 +14,56 @@ Or install it yourself as:
 
     $ gem install quanto-ruby
 
-## Usage
+## Documentation
+
+This gem is a simple OAuth client for Quanto.
+Most of the logic is handled by the underlying OAuth2 library, so this gem is simply a wrapper around authenticated API calls.
+
+To get started, you can create a client like this:
+
+```ruby
+  client = Quanto::Client.new(ENV['QUANTO_KEY'], ENV['QUANTO_SECRET'], access_token: 'my token')
+```
+
+where `'my_token'` should be your actual access token. Once you have a `Client`, you have access to the following methods:
+
+- `#record_entry(value, metric_name, options={})`
+
+    This method records an entry for the given metric in Quanto.
+    The optional third argument lets the user specify a date, but the default is today.
+    For instance, the following call would record 20 steps for today:
+
+    ```ruby
+    client.record_entry(20, :steps)
+    ```
+
+    while this call would record 137 pushups for April 1st 2013.
+
+    ```ruby
+    client.record_entry(137, :pushups, date: '2013-04-01')
+    ```
+
+- `#plugin_url`
+
+    Returns the URL of this plugin on Quanto.
+    Useful when redirecting the user after authenticating.
+
+- `#activate_plugin`
+
+    Activates the plugin in Quanto.
+    This should be called whenever the plugin has successfully obtained all 3rd party credentials and is ready to send data.
 
-TODO: Write usage instructions here
+- `#metrics`
 
-## Contributing
+    Returns a list of metrics enabled for the current plugin of the following format:
 
-1. Fork it
-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
+    ```ruby
+    [{
+      'name' => 'steps',
+      'metric_type' => 'count',
+    },
+    {
+      'name' => 'sleep',
+      'metric_type' => 'minutes',
+    }]
+    ```

data/lib/quanto/client.rb

@@ -5,7 +5,7 @@ module Quanto
   class Client
 
     API_VERSION = "1"
-    QUANTO_URL = "http://tryquanto.com"
+    QUANTO_URL = "http://quanto.herokuapp.com"
 
     def initialize(consumer_key, consumer_secret, options = {})
       @consumer =

data/lib/quanto/version.rb

@@ -1,3 +1,3 @@
 module Quanto
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/spec/quanto_client_spec.rb

@@ -23,7 +23,7 @@ describe Quanto::Client do
 
     it 'passes the quanto URL' do
       expect(OAuth2::Client).to receive(:new) do |key, secret, options|
-        expect(options[:site]).to eq('http://tryquanto.com')
+        expect(options[:site]).to eq('http://quanto.herokuapp.com')
       end
       Quanto::Client.new(consumer_key, consumer_secret)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quanto-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Rasmus Rygaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2