activite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0fc49292ff1cc617edec317ddb65991c408d8b1
-  data.tar.gz: 21d949774ed01cea6fc2eb219616926a5b2f4096
+  metadata.gz: 5acc9c4ef6a8ab53a295b64452a46565c9dddf15
+  data.tar.gz: 46be771ce03ba475e7a051f2264da1a058f2b5ec
 SHA512:
-  metadata.gz: 1e92cca90c65cb4c40ee0af4644aefa399d08395eb06675d8a7e9123fd1bd49b36f800c3c29d7056dfdc455856e85e519cff16358bd915661457c767912307cf
-  data.tar.gz: 3634d67561efa2d67346fd6b5cb52c3c1cd02e8922b97a2fb050e1def9dd500e96a1979ba903c0c5cb02db8f0b9ed7948a9b12324430823ac4843572e3217343
+  metadata.gz: 6bc688ecea0f2ec2c218898516d64b45a7827ea7ac796d2494f41b73b35e24dac8819652e7543f847e4a8dd8a16f118e0f481bbc4cd0d8dbba1d71f6445a9356
+  data.tar.gz: a1b991504b8afb86f74aee85d107bca4e6ecc4c82eb8727f5678464f14b540e3ac47a7bec0ff98ae8c4ec69af3ae7395f39794c408bf7783f77350bcd897c195

data/README.md

@@ -4,20 +4,16 @@
 [![Code Climate](https://codeclimate.com/github/paulosman/activite/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/paulosman/activite/badges/coverage.svg)][coverage]
 [![Dependency Status](https://gemnasium.com/paulosman/activite.svg)][gemnasium]
+[![Gem Version](https://badge.fury.io/rb/activite.svg)][gemversion]
 
 This gem provides access to data collected by [Withings](http://withings.com/) devices through
 their [HTTP API](https://oauth.withings.com/api/doc).
 
-NOTE: This gem is a work in progress. It is not yet available via RubyGems.
-
 [travis]: https://travis-ci.org/paulosman/activite
 [codeclimate]: https://codeclimate.com/github/paulosman/activite
 [coverage]: https://codeclimate.com/github/paulosman/activite
 [gemnasium]: https://gemnasium.com/paulosman/activite
-
-### TODO
-
-* Notifications
+[gemversion]: https://badge.fury.io/rb/activite
 
 ## Installation
 
@@ -133,7 +129,7 @@ sleep_details = client.sleep_series(user_id, {
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/activite/client.rb

@@ -2,15 +2,17 @@ require 'activite/error'
 require 'activite/http/request'
 require 'activite/activity'
 require 'activite/measurement_group'
+require 'activite/notification'
 require 'activite/sleep_series'
 require 'activite/sleep_summary'
+require 'activite/response'
 
 module Activite
   class Client
     include Activite::HTTP::OAuthClient
 
     attr_writer :user_agent
-    
+
     # Initializes a new Client object used to communicate with the Withings API.
     #
     # An authenticated Client can be created with an access token and access token
@@ -109,7 +111,7 @@ module Activite
     #
     # NOTE: user_id isn't actually used in this API call (so I assume it is
     # derived from the OAuth credentials) but I was uncomfortable introducing
-    # this inconsitency into this gem.
+    # this inconsistency into this gem.
     #
     # @param user_id [Intger]
     # @param options [Hash]
@@ -121,6 +123,55 @@ module Activite
       }.merge(options))
     end
 
+    # Register a webhook / notification with the Withings API. This allows
+    # you to be notified when new data is available for a user.
+    #
+    # @param user_id [Integer]
+    # @param options [Hash]
+    #
+    # @return [Activite::Response]
+    def create_notification(user_id, options = {})
+      perform_request(:post, '/notify', Activite::Response, nil, {
+        action: 'subscribe'
+      }.merge(options))
+    end
+
+    # Get information about a specific webhook / notification.
+    #
+    # @param user_id [Integer]
+    # @param options [Hash]
+    #
+    # @return [Activite::Notification]
+    def get_notification(user_id, options = {})
+      perform_request(:get, '/notify', Activite::Notification, nil, {
+        action: 'get'
+      }.merge(options))
+    end
+
+    # Return a list of registered webhooks / notifications.
+    #
+    # @param user_id [Integer]
+    # @param options [Hash]
+    #
+    # @return [Array<Activite::Notification>]
+    def list_notifications(user_id, options = {})
+      perform_request(:get, '/notify', Activite::Notification, 'profiles', {
+        action: 'list'
+      }.merge(options))
+    end
+
+    # Revoke previously subscribed webhook / notification.
+    #
+    # @param user_id [Integer]
+    # @param options [Hash]
+    #
+    # @return [Activite::Response]
+    def revoke_notification(user_id, options = {})
+      perform_request(:get, '/notify', Activite::Response, nil, {
+        action: 'revoke'
+      }.merge(options))
+    end
+
     private
 
     # Helper function that handles all API requests
@@ -139,7 +190,9 @@ module Activite
       options = Activite::Utils.normalize_date_params(options)
       request = Activite::HTTP::Request.new(@access_token, { 'User-Agent' => user_agent })
       response = request.send(http_method, path, options)
-      if response.has_key? key
+      if key.nil?
+        klass.new(response)
+      elsif response.has_key? key
         response[key].collect do |element|
           klass.new(element)
         end

data/lib/activite/http/oauth.rb

@@ -4,6 +4,7 @@ module Activite
   module HTTP
     module OAuthClient
       attr_accessor :consumer_key, :consumer_secret, :token, :secret
+      attr_writer :consumer
 
       DEFAULT_OPTIONS = {
         site:              'https://oauth.withings.com',
@@ -13,7 +14,7 @@ module Activite
         access_token_path:  '/account/access_token',
         scheme:             :query_string
       }
-    
+
       def request_token(options = {})
         consumer.get_request_token(options)
       end
@@ -34,13 +35,13 @@ module Activite
       def existing_access_token(token, secret)
         OAuth::AccessToken.new(consumer, token, secret)
       end
-      
+
       def connected?
         !@access_token.nil?
       end
 
       private
-      
+
       def consumer
         @consumer ||= OAuth::Consumer.new(@consumer_key, @consumer_secret, DEFAULT_OPTIONS)
       end

data/lib/activite/http/request.rb

@@ -13,22 +13,48 @@ module Activite
       end
 
       def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      def post(path, options = {})
+        request(:post, path, options)
+      end
+
+      protected
+
+      def hash_to_query(hash)
+        return URI.encode(hash.map{|k,v| "#{k}=#{v}"}.join("&"))
+      end
+
+      def request_with_body(method, path, options = {})
+        body = hash_to_query(options)
+        uri  = "#{BASE_URI}#{path}"
+        @access_token.send(method, uri, body, @headers)
+      end
+
+      def request_with_query_string(method, path, options = {})
         uri = "#{BASE_URI}#{path}?#{hash_to_query(options)}"
-        response = @access_token.get(uri, @headers)
+        @access_token.send(method, uri, @headers)
+      end
+
+      def request(method, path, options = {})
+        if [:post, :put].include? method
+          response = request_with_body(method, path, options)
+        else
+          response = request_with_query_string(method, path, options)
+        end
+
         if response.code.to_i < 200 or response.code.to_i >= 400
           raise Activite::Error::ClientConfigurationError, response.body
         end
+
         body = JSON.parse(response.body)
         if body['status'].to_i != 0
           raise Activite::Error::InvalidResponseError, "#{body['status']} - #{body['error']}"
         end
-        body['body']
-      end
-      
-      protected
 
-      def hash_to_query(hash)
-        return URI.encode(hash.map{|k,v| "#{k}=#{v}"}.join("&"))
+        body['body'] ||= body
+        body['body']
       end
     end
   end

data/lib/activite/notification.rb

@@ -0,0 +1,4 @@
+module Activite
+  class Notification < Base
+  end
+end

data/lib/activite/response.rb

@@ -0,0 +1,13 @@
+module Activite
+
+  # A Response is used to represent an empty API response with a status
+  # code and no additional information.
+  class Response
+    # @return [Integer]
+    attr_reader :status
+
+    def initialize(attrs = {})
+      @status = attrs['status'].to_i if attrs.has_key? 'status'
+    end
+  end
+end

data/lib/activite/version.rb

@@ -1,3 +1,3 @@
 module Activite
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -93,6 +93,8 @@ files:
 - lib/activite/http/request.rb
 - lib/activite/measurement_group.rb
 - lib/activite/measures.rb
+- lib/activite/notification.rb
+- lib/activite/response.rb
 - lib/activite/sleep_series.rb
 - lib/activite/sleep_summary.rb
 - lib/activite/utils.rb