simplificator-withings 0.2.2 → 0.2.3

data/README.rdoc

@@ -18,15 +18,19 @@ will make an API call to populate the attributes, User.new just requires user_id
 
 == TODO
 
-* Need to test parameter generation for get measurement
 * Integration Test? But i don't want to share my credentials... Perhaps with a test account on withings?
 
 == Remarks
 
 * The gem is still under development and the API might change a bit.
-* Authentication by user_id/public_key is only supported when the user has activated sharing. He can do this either in the sharing overlay on my.withings.com or through the api (user.share = true) after authentication by email/password
-* As soon as the user sets sharing to false (user.share = false) the public_key is reset and upon next activation of sharing (user.share = true) a new public_key is assigned.
-* All the methods making remote calls can throw Withing::ApiError if something goes wrong (wrong public_key, missing parameters, ...). You can find more details on the error by looking at the status code in the error.
+* Authentication by user_id/public_key is only supported when the user has activated sharing.
+  He can do this either in the sharing overlay on my.withings.com or
+  through the api (user.share = true) after authentication by email/password
+* As soon as the user sets sharing to false (user.share = false) the public_key is reset
+  and upon next activation of sharing (user.share = true) a new public_key is assigned.
+* All the methods making remote calls can throw Withing::ApiError if something goes wrong
+  (wrong public_key, missing parameters, ...).
+  You can find more details on the error by looking at the status code in the error.
 
 == How To
 

data/lib/withings/connection.rb

@@ -1,31 +1,33 @@
+# A convenience class for making get requests to WBS API.
+# It verifies the response and raises ApiError if a call failed.
 class Withings::Connection
   include HTTParty
   base_uri 'wbsapi.withings.net'
   format :json
 
-  attr_reader :user
   def initialize(user)
     @user = user
   end
 
   def self.get_request(path, params)
     response = self.get(path, :query => params)
-    verify_response!(response)
+    verify_response!(response, path, params)
   end
 
+  # Merges the params with public_key and user_id for authentication.
   def get_request(path, params)
-    response = self.class.get(path, :query => params.merge(:publickey => user.public_key, :userid => user.user_id))
-    self.class.verify_response!(response)
+    params =  params.merge(:publickey => @user.public_key, :userid => @user.user_id)
+    response = self.class.get(path, :query => params)
+    self.class.verify_response!(response, path, params)
   end
 
   protected
-  def self.verify_response!(response)
+  # Verifies the status code in the JSON response and returns either the body element or raises ApiError
+  def self.verify_response!(response, path, params)
     if response['status'] == 0
       response['body'] || response['status']
     else
-      raise ApiError.new(response['status'])
+      raise ApiError.new(response['status'], path, params)
     end
-
   end
-
 end

data/lib/withings/error.rb

@@ -1,22 +1,32 @@
 class Withings::ApiError < StandardError
+  UNKNOWN_STATUS_CODE = lambda() {|status, path, params| "Unknown status code '#{status}'"}
   STATUS_CODES = {
-    100	  => "The hash is missing, invalid, or does not match the provided email",
-    247	  => "The userid is either absent or incorrect",
-    250	  => "The userid and publickey provided do not match, or the user does not share its data",
-    264	  => "The email address provided is either unknown or invalid",
-    293	  => "The callback URL is either absent or incorrect",
-    294	  => "No such subscription could be deleted",
-    304	  => "The comment is either absent or incorrect",
-    2555	=> "An unknown error occurred",
+    100	  => lambda() {|status, path, params| "The hash '#{params[:hash]}' does not match the email '#{params[:email]}'"},
+    247	  => lambda() {|status, path, params| "The '#{params[:userid]}' is invalid"},
+    250	  => lambda() {|status, path, params| "The userid '#{params[:userid]}' and publickey '#{params[:publickey]}' do not match, or the user does not share its data"},
+    264	  => lambda() {|status, path, params| "The email address '#{params[:email]}' is either unknown or invalid"},
+    286   => lambda() {|status, path, params| "No subscription for '#{params[:callbackurl]}' was found" },
+    293	  => lambda() {|status, path, params| "The callback URL '#{params[:callbackurl]}' is either unknown or invalid"},
+    294	  => lambda() {|status, path, params| "Could not delete subscription for '#{params[:callbackurl]}'"},
+    304	  => lambda() {|status, path, params| "The comment '#{params[:comment]}' is invalid"},
+    2554	=> lambda() {|status, path, params| "Unknown action '#{params[:action]}' for '#{path}'"},
+    2555	=> lambda() {|status, path, params| "An unknown error occurred"},
   }
 
   attr_reader :status
-  def initialize(status)
-    super(STATUS_CODES[status] || "Undefined status code. We do not have any description about the code #{status}. If you know more, then please let me know.")
+  def initialize(status, path, params)
+    super(build_message(status, path, params))
     @status = status
   end
 
   def to_s
     super + " - Status code: #{self.status}"
   end
+
+
+  protected
+
+  def build_message(status, path, params)
+    (STATUS_CODES[status] || UNKNOWN_STATUS_CODE).call(status, path, params)
+  end
 end

data/simplificator-withings.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplificator-withings}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["pascalbetz"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-withings
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - pascalbetz