beeminder 0.2.3 → 0.2.4

data/TODO

@@ -1,4 +1,5 @@
-* TODO [0/3]
+* TODO [0/4]
 - [ ] add a few more sanity checks
 - [ ] cache goals / datapoints
 - [ ] add update function to Datapoint
+- [ ] constructors could be more elegant, but don't wanna break compatibility again, so it can wait until the next major rewrite

data/beeminder.gemspec

@@ -16,8 +16,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
+  gem.add_dependency 'activesupport', '~> 3.2'
   gem.add_dependency 'chronic', '~> 0.7'
   gem.add_dependency 'json'
   gem.add_dependency 'highline', '~> 1.6'
   gem.add_dependency 'trollop', '~> 2'
+  gem.add_dependency 'tzinfo'
 end

data/lib/beeminder.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+require 'active_support/core_ext'
 require 'date'
 require 'json'
 require 'net/https'

data/lib/beeminder/goals.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# -*- encoding: utf-8 -*-
 
 module Beeminder
   class Goal
@@ -81,7 +81,13 @@ module Beeminder
     # @return [Array<Beeminder::Datapoint>] returns list of datapoints
     def datapoints
       info = @user.get "users/me/goals/#{slug}/datapoints.json"
-      datapoints = info.map{|d| Datapoint.new d}
+      datapoints = info.map do |d_info|
+        d_info = {
+          :goal => self,
+        }.merge(d_info)
+
+        Datapoint.new d_info
+      end
 
       datapoints
     end
@@ -106,8 +112,12 @@ module Beeminder
     def dial_road dials={}
       raise "Set exactly two dials." if dials.keys.size != 2
 
-      dials["goaldate"] = dials["goaldate"].strftime('%s') unless dials["goaldate"].nil?
-
+      # convert to proper timestamp
+      unless dials["goaldate"].nil?
+        dials["goaldate"] = @user.convert_to_timezone dials["goaldate"] if @user.enforce_timezone?
+        dials["goaldate"] = dials["goaldate"].strftime('%s')
+      end
+        
       @user.post "users/me/goals/#{@slug}/dial_road.json", dials
     end
     
@@ -117,12 +127,15 @@ module Beeminder
     def add datapoints, opts={}
       datapoints = [*datapoints]
 
-      # FIXME create_all doesn't work because Ruby's POST encoding of arrays is broken.
       datapoints.each do |dp|
+        # we grab these datapoints for ourselves
+        dp.goal = self
+        
         data = {
           "sendmail" => opts[:sendmail] || false
         }.merge(dp.to_hash)
 
+        # TODO create_all doesn't work because Ruby's POST encoding of arrays is broken.
         @user.post "users/me/goals/#{@slug}/datapoints.json", data
       end
     end
@@ -160,10 +173,10 @@ module Beeminder
       end
 
       # some conversions
-      @goaldate   = DateTime.strptime(@goaldate.to_s,   '%s') unless @goaldate.nil?
+      @goaldate   = DateTime.strptime(@goaldate.to_s,   '%s').in_time_zone(@user.timezone) unless @goaldate.nil?
       @goal_type  = @goal_type.to_sym unless @goal_type.nil?
-      @losedate   = DateTime.strptime(@losedate.to_s,   '%s') unless @losedate.nil?
-      @updated_at = DateTime.strptime(@updated_at.to_s, '%s')
+      @losedate   = DateTime.strptime(@losedate.to_s,   '%s').in_time_zone(@user.timezone) unless @losedate.nil?
+      @updated_at = DateTime.strptime(@updated_at.to_s, '%s').in_time_zone(@user.timezone)
     end
   end
 
@@ -183,6 +196,10 @@ module Beeminder
     # @return [DateTime] The time that this datapoint was entered or last updated.
     attr_reader :updated_at
 
+    # @return [Beeminder::Goal] Goal this datapoint belongs to.
+    #   Optional for new datapoints. Use `Goal#add` to add new datapoints to a goal.
+    attr_accessor :goal
+    
     def initialize info={}
       # set variables
       info.each do |k,v|
@@ -196,11 +213,21 @@ module Beeminder
       # some conversions
       @timestamp  = DateTime.strptime(@timestamp.to_s,  '%s') unless @timestamp.is_a?(Date) || @timestamp.is_a?(Time)
       @updated_at = DateTime.strptime(@updated_at.to_s, '%s') unless @updated_at.nil?
+
+      # set timezone if possible
+      unless @goal.nil?
+        @timestamp  = @timestamp.in_time_zone  @goal.user.timezone
+        @updated_at = @updated_at.in_time_zone @goal.user.timezone
+      end
     end
 
     # Convert datapoint to hash for POSTing.
     # @return [Hash]
     def to_hash
+      if not @goal.nil? and @goal.user.enforce_timezone?
+        @timestamp = @goal.user.convert_to_timezone @timestamp
+      end
+      
       {
         "timestamp" => @timestamp.strftime('%s'),
         "value"     => @value || 0,

data/lib/beeminder/user.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# -*- encoding: utf-8 -*-
 
 module Beeminder
   class User
@@ -16,14 +16,19 @@ module Beeminder
 
     # @return [Symbol] Type of user, can be `:personal` (default) or `:oauth`.
     attr_reader :auth_type
+
+    # @return [true|false] Enforce user timezone for all passed times? Should be true unless you know what you're doing. (Default: `true`.)
+    attr_accessor :enforce_timezone
     
     def initialize token, opts={}
       opts = {
         :auth_type => :personal,
+        :enforce_timezone => true,
       }.merge(opts)
       
-      @token     = token
-      @auth_type = opts[:auth_type]
+      @token            = token
+      @auth_type        = opts[:auth_type]
+      @enforce_timezone = opts[:enforce_timezone]
 
       @token_type =
         case @auth_type
@@ -38,14 +43,21 @@ module Beeminder
       info = get "users/me.json"
 
       @name       = info["username"]
-      @timezone   = info["timezone"]
-      @updated_at = DateTime.strptime(info["updated_at"].to_s, '%s')
+      @timezone   = info["timezone"] || "UTC"
+      @updated_at = DateTime.strptime(info["updated_at"].to_s, '%s').in_time_zone(@timezone)
     end
 
+    # Enforce timezone for all passed times? 
+    #
+    # @return [true|false]
+    def enforce_timezone?
+      !!@enforce_timezone
+    end
+    
     # List of goals.
     #
     # @param filter [Symbol] filter goals, can be `:all` (default), `:frontburner` or `:backburner`
-    # @ return [Array<Beeminder::Goal>] returns list of goals
+    # @return [Array<Beeminder::Goal>] returns list of goals
     def goals filter=:all
       raise "invalid goal filter: #{filter}" unless [:all, :frontburner, :backburner].include? filter
 
@@ -115,8 +127,25 @@ module Beeminder
       _connection :put, cmd, data
     end
 
-    private
+    # Converts time object to one with user's timezone.
+    #
+    # @param time [Date|DateTime|Time] Time to convert.
+    # @return [Time] Converted time.
+    def convert_to_timezone time
+      # TODO seems way too hack-ish
+      old_tz = Time.zone
+      Time.zone = @timezone
+      
+      time = time.to_time
+      t = Time.new(time.year, time.month, time.day, time.hour, time.min, time.sec)
+
+      Time.zone = old_tz
+
+      t
+    end
 
+    private
+    
     # Establish HTTPS connection to API.
     def _connection type, cmd, data
       api  = "https://www.beeminder.com/api/v1/#{cmd}"
@@ -128,7 +157,7 @@ module Beeminder
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE # FIXME: actually verify
 
-      # FIXME Sanity check for wrong timestamp. Source of bug unknown, so we prevent screwing up someone's graph.
+      # FIXME Sanity check for wrong timestamp. Source of bug unknown, but at least we can prevent screwing up someone's graph.
       unless data["timestamp"].nil?
         if not data["timestamp"].match(/^\d+$/) or data["timestamp"] < "1280000000"
           raise ArgumentError, "invalid timestamp: #{data["timestamp"]}"

data/lib/beeminder/version.rb

@@ -1,3 +1,3 @@
 module Beeminder
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beeminder
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-16 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convenient access to Beeminder's API.
 email:
 - mail@muflax.com
@@ -110,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4420533533001191387
+      hash: 4040090933613779056
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4420533533001191387
+      hash: 4040090933613779056
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23