fitgem 0.3.6 → 0.4.0

data/lib/fitgem/users.rb

@@ -1,18 +1,30 @@
 module Fitgem
   class Client
-
-    def user_info(options = {})
-      get("/user/#{@user_id}/profile.json")
+    # Get information aobut current user
+    #
+    # @param [Hash] opts User information request data
+    # @return [Hash] User information
+    def user_info(opts={})
+      get("/user/#{@user_id}/profile.json", opts)
     end
 
-    # options[:gender] optional Gender; (MALE/FEMALE/NA)
-    # options[:birthday] optional Date of Birth; in the format yyyy-MM-dd
-    # options[:height] optional Height
-    # options[:nickname] optional Nickname
-    # options[:fullName] optional Full name
-    # options[:timezone] optional Timezone; in the format "America/Los_Angeles"
-    def update_user_info(options)
-      post("/user/#{@user_id}/profile.json", options)
+    # Update profile information for current user
+    #
+    # @param [Hash] opts User profile information
+    # @option opts [String] :gender Gender, valid values are MALE, FEMALE, NA
+    # @option opts [DateTime, Date, String] :birthday Birthday, in
+    #   "yyyy-MM-dd" if a String
+    # @option opts [Decimal, Integer, String] :height Height, in format
+    #   "X.XX" if a string
+    # @option opts [String] :nickname Nickname
+    # @option opts [String] :fullName Full name
+    # @option opts [String] :timezone Time zone; in the format
+    #   "America/Los Angelos"
+    #
+    # @return [Hash] Hash containing updated profile information
+    def update_user_info(opts)
+      opts[:birthday] = format_date(opts[:birthday]) if opts[:birthday]
+      post("/user/#{@user_id}/profile.json", opts)
     end
 
   end

data/lib/fitgem/version.rb

@@ -1,3 +1,3 @@
 module Fitgem
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/lib/fitgem/water.rb

@@ -1,9 +1,14 @@
 module Fitgem
   class Client
-
     # ==========================================
     #          Water Retrieval Methods
     # ==========================================
+
+    # Get water log entries for the supplied date
+    #
+    # @param [DateTime, Date, String] date
+    # @return [Hash] Hash containing the summary of the days logs, and a
+    #   list of all individual entries
     def water_on_date(date)
       get("/user/#{@user_id}/foods/log/water/date/#{format_date(date)}.json")
     end
@@ -13,22 +18,33 @@ module Fitgem
     #          Water Logging Methods
     # ==========================================
 
-    # options[:amount]    Required
-    # options[:unit]      Optional    ("ml", "fl oz" or "cup")
-    # options[:date]      Required    yyyy-MM-dd format
-    def log_water(options)
-      unless options[:amount] && options[:date]
-        raise "Must include both an :amount and :date to log water"
+    # Log water consumption to fitbit
+    #
+    # @param [Hash] opts Water consumption data
+    # @option opts [Integer, Decimal, String] :amount Amount of water
+    #   consumed; if String must be in "X.X" format
+    # @option opts [String] :unit Unit of water consumed; valid values
+    #   are ("ml", "fl oz" or "cup")
+    # @option opts [DateTime, Date, String] :date Date of water
+    #   consumption
+    #
+    # @return [Hash] Summary of logged information
+    def log_water(opts)
+      unless opts[:amount] && opts[:date]
+        raise Fitgem::InvalidArgumentError, "Must include both an :amount and :date to log water"
       end
-      post("/user/#{@user_id}/foods/log/water.json",options)
-    end
 
-    # ==========================================
-    #        Water Log Deletion Methods
-    # ==========================================
+      opts[:date] = format_date(opts[:date])
+      post("/user/#{@user_id}/foods/log/water.json",opts)
+    end
 
-    def delete_water_log(log_id)
-      delete("/user/-/foods/log/water/#{log_id}.json")
+    # Delete logged water consumption
+    #
+    # @param [Integer, String] water_log_id The id of previously logged
+    #   water consumption
+    # @return [Hash] Empty hash denotes success
+    def delete_water_log(water_log_id)
+      delete("/user/-/foods/log/water/#{water_log_id}.json")
     end
   end
 end

data/spec/fitgem_constructor_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Fitgem::Client do
+  describe "constructor" do
+    it "requires consumer_key" do
+      expect {
+        opts = { :consumer_secret => "12345" }
+        client = Fitgem::Client.new(opts)
+      }.to raise_error(Fitgem::InvalidArgumentError, "Missing required options: consumer_key")
+    end
+
+    it "requires consumer_secret" do
+      expect {
+        opts = { :consumer_key => "12345" }
+        client = Fitgem::Client.new(opts)
+      }.to raise_error(Fitgem::InvalidArgumentError, "Missing required options: consumer_secret")
+    end
+  end
+end

data/spec/fitgem_helper_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Fitgem::Client do
+  before(:each) do
+    @client = Fitgem::Client.new({
+      :consumer_key => '12345',
+      :consumer_secret => '67890'
+    })
+  end
+
+  describe "#construct_date_range_fragment" do
+    it 'should format the correct URI fragment based on a base date and end date' do
+      frag = @client.construct_date_range_fragment({:base_date => '2011-03-07', :end_date => '2011-03-14'})
+      frag.should == 'date/2011-03-07/2011-03-14'
+    end
+
+    it 'should format the correct URI fragment based on a base date and period' do
+      frag = @client.construct_date_range_fragment({:base_date => '2011-03-07', :period => '7d'})
+      frag.should == 'date/2011-03-07/7d'
+    end
+
+    it 'should raise an error unless there is a base date AND either a period or an end date' do
+      expect {
+        @client.construct_date_range_fragment({:base_date => '2011-03-07'})
+      }.to raise_error(Fitgem::InvalidTimeRange)
+
+      expect {
+        @client.construct_date_range_fragment({:period => '1y'})
+      }.to raise_error(Fitgem::InvalidTimeRange)
+
+      expect {
+        @client.construct_date_range_fragment({:end_date => '2011-03-07', :period => '7d'})
+      }.to raise_error(Fitgem::InvalidTimeRange)
+    end
+  end
+
+  describe "#format_date" do
+    it "accepts DateTime objects" do
+      date = DateTime.strptime('2011-03-19','%Y-%m-%d')
+      @client.format_date(date).should == '2011-03-19'
+    end
+
+    it "accepts strings in YYYY-MM-DD format" do
+      @client.format_date('2011-03-19').should == '2011-03-19'
+    end
+
+    it "accepts the string 'today' to denote the current date" do
+      today = Date.today.strftime("%Y-%m-%d")
+      @client.format_date('today').should == today
+    end
+
+    it "accepts the string 'yesterday' to denote the day previous to today" do
+      yesterday = (Date.today-1).strftime("%Y-%m-%d")
+      @client.format_date('yesterday').should == yesterday
+    end
+
+    it "rejects strings that are not in YYY-MM-DD format" do
+      date = "2011-3-2"
+      expect {
+        @client.format_date(date)
+      }.to raise_error Fitgem::InvalidDateArgument, "Invalid date (2011-3-2), must be in yyyy-MM-dd format" 
+    end
+
+    it "rejects strings are formatted correctly but include non-numeric elements" do
+      date = "2011-aa-20"
+      expect {
+        @client.format_date(date)
+      }.to raise_error Fitgem::InvalidDateArgument, "Invalid date (2011-aa-20), must be in yyyy-MM-dd format"
+    end
+
+    it "rejects arguments that are not a Date, Time, DateTime, or String" do
+      date = 200
+      expect {
+        @client.format_date(date)
+      }.to raise_error Fitgem::InvalidDateArgument, "Date used must be a date/time object or a string in the format YYYY-MM-DD; supplied argument is a Fixnum"
+    end
+  end 
+end

data/spec/fitgem_notifications_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Fitgem::Client do
+  before(:each) do
+    @client = Fitgem::Client.new({:consumer_key => '12345', :consumer_secret => '56789'})
+  end
+
+  describe "#subscriptions" do
+    before(:each) do
+      @client.stub :get
+    end
+
+    it "calls #make_headers to create the headers for the API call" do
+      opts = { :subscriber_id => "5555", :type => :all }
+      @client.should_receive(:make_headers).with({:type=>:all, :subscriber_id=>"5555"})
+      @client.subscriptions(opts)
+    end
+
+    it "calls #get with the correct url and headers" do
+      opts = { :subscriber_id => "5555", :type => :all }
+      @client.should_receive(:get).with("/user/-/apiSubscriptions.json", {"X-Fitbit-Subscriber-Id"=>"5555"})
+      @client.subscriptions(opts)
+    end
+  end
+
+  describe "#create_subscription" do
+    before(:each) do
+      @resp = OpenStruct.new
+      @client.stub(:raw_post).and_return(@resp)
+    end
+
+    it "adds the :use_subscription_id flag and calls #make_headers" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320" }
+      @client.should_receive(:make_headers).with({ :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true })
+      @client.create_subscription(opts)
+    end
+
+    it "calls #raw_post with the correct url and headers for :all collection type" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @client.should_receive(:raw_post).once.with("/user/-/apiSubscriptions/320.json", "", {"X-Fitbit-Subscriber-Id"=>"5555"})
+      @client.create_subscription(opts)
+    end
+
+    it "calls #raw_post with the correct url and headers for :sleep collection type" do
+      opts = { :subscriber_id => "5555", :type => :sleep, :subscription_id => "320", :use_subscription_id => true }
+      @client.should_receive(:raw_post).once.with("/user/-/sleep/apiSubscriptions/320.json", "", {"X-Fitbit-Subscriber-Id"=>"5555"})
+      @client.create_subscription(opts)
+    end
+
+    it "calls #extract_response_body to get the JSON body" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @client.should_receive(:extract_response_body)
+      @client.create_subscription(opts)
+    end
+
+    it "returns the code and the JSON body in an array" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @resp.should_receive(:code)
+      @client.create_subscription(opts).should be_a(Array)
+    end
+  end
+
+  describe "#remove_subscription" do
+    before(:each) do
+      @resp = OpenStruct.new
+      @client.stub(:raw_delete).and_return(@resp)
+    end
+
+    it "adds the :use_subscription_id flag and calls #make_headers" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320" }
+      @client.should_receive(:make_headers).with({ :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true })
+      @client.remove_subscription(opts)
+    end
+
+    it "calls #raw_delete with the correct url and headers for :all collection type" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @client.should_receive(:raw_delete).once.with("/user/-/apiSubscriptions/320.json", {"X-Fitbit-Subscriber-Id"=>"5555"})
+      @client.remove_subscription(opts)
+    end
+
+    it "calls #extract_response_body to get the JSON body" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @client.should_receive(:extract_response_body)
+      @client.remove_subscription(opts)
+    end
+
+    it "returns the code and the JSON body in an array" do
+      opts = { :subscriber_id => "5555", :type => :all, :subscription_id => "320", :use_subscription_id => true }
+      @resp.should_receive(:code)
+      @client.remove_subscription(opts).should be_a(Array)
+    end
+  end
+
+  describe "#validate_subscription_types" do
+    it "raises an exception if an invalid type is passed in" do
+      expect {
+        @client.send(:validate_subscription_type, :every_single_thing)
+      }.to raise_error Fitgem::InvalidArgumentError, "Invalid subscription type (valid values are sleep, body, activities, foods, all)"
+    end
+
+    it "raises an exception if no type is supplied" do
+      opts = { :opt1 => 'hello!' }
+      expect {
+        @client.send(:validate_subscription_type, opts[:type])
+      }.to raise_error Fitgem::InvalidArgumentError
+    end
+  end
+
+  describe "#make_headers" do
+    it "adds the subscriber id header" do
+      opts = { :subscriber_id => '5555', :subscription_id => '320-activity' }
+      headers = @client.send(:make_headers, opts)
+      headers.size.should == 1
+      headers['X-Fitbit-Subscriber-Id'].should == "5555"
+    end
+  end
+
+  describe "#make_subscription_url" do
+    it "creates the correct URL when no specific subscription id is used" do
+      opts = { :subscription_id => "320", :type => :all }
+      @client.send(:make_subscription_url, opts).should == "/user/-/apiSubscriptions.json"
+    end
+
+    it "creates the correct URL for :all collection types" do
+      opts = { :subscription_id => "320", :type => :all, :use_subscription_id => true }
+      @client.send(:make_subscription_url, opts).should == "/user/-/apiSubscriptions/320.json"
+    end
+
+    it "creates the correct URL for the :sleep collection type" do
+      opts = { :subscription_id => "320", :type => :sleep, :use_subscription_id => true }
+      @client.send(:make_subscription_url, opts).should == "/user/-/sleep/apiSubscriptions/320.json"
+    end
+
+    it "creates the correct URL for the :body collection type" do
+      opts = { :subscription_id => "320", :type => :body, :use_subscription_id => true }
+      @client.send(:make_subscription_url, opts).should == "/user/-/body/apiSubscriptions/320.json"
+    end
+
+    it "creates the correct URL for the :activities collection type" do
+      opts = { :subscription_id => "320", :type => :activities, :use_subscription_id => true }
+      @client.send(:make_subscription_url, opts).should == "/user/-/activities/apiSubscriptions/320.json"
+    end
+
+    it "creates the correct URL for the :foods collection type" do
+      opts = { :subscription_id => "320", :type => :foods, :use_subscription_id => true }
+      @client.send(:make_subscription_url, opts).should == "/user/-/foods/apiSubscriptions/320.json"
+    end
+
+    it "validates the supplied subscription type" do
+      opts = { :subscription_id => "320" }
+      expect { @client.send(:make_subscription_url, opts) }.to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = nil
+      expect { @client.send(:make_subscription_url, opts) }.to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = :all
+      expect { @client.send(:make_subscription_url, opts) }.not_to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = :activities
+      expect { @client.send(:make_subscription_url, opts) }.not_to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = :sleep
+      expect { @client.send(:make_subscription_url, opts) }.not_to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = :foods
+      expect { @client.send(:make_subscription_url, opts) }.not_to raise_error Fitgem::InvalidArgumentError
+
+      opts[:type] = :body
+      expect { @client.send(:make_subscription_url, opts) }.not_to raise_error Fitgem::InvalidArgumentError
+    end
+  end
+end

data/spec/fitgem_spec.rb

@@ -1,9 +1,11 @@
 require 'spec_helper'
 
 describe Fitgem do
-
   before do
-    @client = Fitgem::Client.new
+    @client = Fitgem::Client.new({
+      :consumer_key => '12345', 
+      :consumer_secret => '67890'
+    })
   end
 
   describe "global settings" do
@@ -31,53 +33,4 @@ describe Fitgem do
       @client.user_id.should == '-'
     end
   end
-
-  describe "data retrieval by time range" do
-
-    it 'should format the correct URI fragment based on a base date and end date' do
-      frag = @client.construct_date_range_fragment({:base_date => '2011-03-07', :end_date => '2011-03-14'})
-      frag.should == 'date/2011-03-07/2011-03-14'
-    end
-
-    it 'should format the correct URI fragment based on a base date and period' do
-      frag = @client.construct_date_range_fragment({:base_date => '2011-03-07', :period => '7d'})
-      frag.should == 'date/2011-03-07/7d'
-    end
-
-    it 'should raise an error unless there is a base date AND either a period or an end date' do
-      lambda {
-        @client.construct_date_range_fragment({:base_date => '2011-03-07'})
-      }.should raise_error(Fitgem::InvalidTimeRange)
-
-      lambda {
-        @client.construct_date_range_fragment({:period => '1y'})
-      }.should raise_error(Fitgem::InvalidTimeRange)
-
-      lambda {
-        @client.construct_date_range_fragment({:end_date => '2011-03-07', :period => '7d'})
-      }.should raise_error(Fitgem::InvalidTimeRange)
-    end
-
-  end
-
-  describe "format_date" do
-    it "accepts DateTime objects" do
-      date = DateTime.strptime('2011-03-19','%Y-%m-%d')
-      @client.format_date(date).should == '2011-03-19'
-    end
-
-    it "accepts strings in YYYY-MM-DD format" do
-      @client.format_date('2011-03-19').should == '2011-03-19'
-    end
-
-    it "accepts the string 'today' to denote the current date" do
-      today = Date.today.strftime("%Y-%m-%d")
-      @client.format_date('today').should == today
-    end
-
-    it "accepts the string 'yesterday' to denote the day previous to today" do
-      yesterday = (Date.today-1).strftime("%Y-%m-%d")
-      @client.format_date('yesterday').should == yesterday
-    end
-  end
-end
+end