beeminder 0.1.9 → 0.2.1

data/CHANGES.md

@@ -0,0 +1,11 @@
+# Major Changes
+
+## 0.2 (2012/09/12)
+
+- Don't need to specify user names any more. It's just `User.new token` now.
+- Support for OAuth tokens with `:auth_type => :oauth`.
+- Fewer unnecessary API calls.
+
+## 0.1 (2012/09/05)
+
+- First release.

data/README.md

@@ -20,7 +20,11 @@ Or install it yourself as:
 
 First, get your token [here](https://www.beeminder.com/api/v1/auth_token.json) and log in:
 
-    bee = Beeminder::User.new "username", "token"
+    # normal login
+    bee = Beeminder::User.new "token"
+
+    # oauth
+    bee = Beeminder::User.new "token", :auth_type => :oauth
 
 Now you can do a bunch of stuff. You'll probably want to send a new datapoint:
 

data/TODO

@@ -1,7 +1,4 @@
-* TODO [3/5]
-- [X] document code
-- [ ] use token to identify user, remove name argument
-- [X] beemind binary
-- [X] implement actual API calls
+* TODO [0/3]
 - [ ] add a few more sanity checks
-- [ ] don't load goal info twice (wtf was I thinking?)
+- [ ] cache goals / datapoints
+- [ ] add update function to Datapoint

data/beeminder.gemspec

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

data/bin/beemind

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
+require 'chronic'
 require 'highline/import'
 require 'trollop'
 require 'yaml'
@@ -20,41 +21,41 @@ usage = "usage: beemind goal value [comment]"
 opts = Trollop::options do
   banner usage
 
-  opt :config,    "Path to config.", :type => :string, :default => "~/.beeminderrc"
-  opt :list,      "List all available goals."
-  opt :user,      "Beeminder account. (Optional. If not given, reads config or asks for it.)", :type => :string
-  opt :token,     "Auth token. (Optional. If not given, reads config or asks for it.)",        :type => :string
+  opt :config, "Path to config.", :type => :string, :default => "~/.beeminderrc"
+  opt :list,   "List all available goals."
+  opt :token,  "Use this auth token instead of config. (Optional. Will ask for it if none given.)", :type => :string
+  opt :date,   "Set a manual date. Uses Chronic syntax.", :type => :string, :default => "now"
 end
 
 Trollop::die usage if not (2..3).include?(ARGV.size) and not opts[:list]
 goal, value, comment = ARGV unless opts[:list]
 
 opts[:config] = File.expand_path opts[:config]
-opts[:no_config] = true if opts[:user] or opts[:token]
 
-if File.exists? opts[:config]
-  # read config to fill in the gaps
-  auth = YAML.load File.open(opts[:config]) || {}
-  opts[:user]  ||= auth["user"]
-  opts[:token] ||= auth["token"]
-end
+if not opts[:token]
+  # read config
+  if File.exists? opts[:config]
+    # read config to fill in the gaps
+    auth = YAML.load File.open(opts[:config]) || {}
+    opts[:token] ||= auth["token"]
+  end
 
-# ask for missing data
-if opts[:user].nil? or opts[:token].nil?
-  opts[:user]  ||= ask("Beeminder account:")
-  opts[:token] ||= ask("Auth token:")
+  # still empty? ask!
+  if opts[:token].nil?
+    opts[:token] = ask("Auth token:")
 
-  auth = {
-    "user"  => opts[:user],
-    "token" => opts[:token]
-  }
-  File.open(opts[:config], "w+") {|f| YAML.dump auth, f}
-  File.chmod 0600, opts[:config]
-  puts "Written config to '#{opts[:config]}.'"
+    # save config for later
+    auth = {
+      "token" => opts[:token]
+    }
+    File.open(opts[:config], "w+") {|f| YAML.dump auth, f}
+    File.chmod 0600, opts[:config]
+    puts "Written config to '#{opts[:config]}.'"
+  end
 end
 
 # login
-bee = Beeminder::User.new opts[:user], opts[:token]
+bee = Beeminder::User.new opts[:token]
 
 if opts[:list]
   # list all available goals
@@ -63,5 +64,10 @@ if opts[:list]
     puts "  #{goal.slug} (#{goal.title})"
   end
 else
-  bee.send goal, value, comment || ""
+  date = Chronic.parse(opts[:date])
+  Trollop::die "invalid date" if date.nil?
+
+  g = bee.goal goal
+  dp = Beeminder::Datapoint.new :timestamp => date, :value => value, :comment => (comment || "")
+  g.add dp
 end

data/lib/beeminder/goals.rb

@@ -54,34 +54,33 @@ module Beeminder
     # @return [Beeminder::User] User that owns this goal.
     attr_reader :user
     
-    def initialize user, name
+    def initialize user, name_or_info
       @user = user
-      @slug = name
+
+      info =
+        case name_or_info
+        when String
+          @user.get "users/me/goals/#{name_or_info}.json"
+        when Hash
+          name_or_info
+        else
+          raise ArgumentError, "`name_or_info` must be String (slug) or Hash (preloaded info)"
+        end
       
-      reload
+      _parse_info info
     end
 
     # Reload data from Beeminder.
     def reload
-      info = @user.get "users/#{@user.name}/goals/#{@slug}.json"
-
-      # set variables
-      info.each do |k,v|
-        instance_variable_set "@#{k}", v
-      end
-
-      # some conversions
-      @goaldate   = DateTime.strptime(@goaldate.to_s,   '%s') 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')
+      info = @user.get "users/me/goals/#{@slug}.json"
+      parse_info info
     end
 
     # List of datapoints.
     #
     # @return [Array<Beeminder::Datapoint>] returns list of datapoints
     def datapoints
-      info = @user.get "users/#{@user.name}/goals/#{slug}/datapoints.json"
+      info = @user.get "users/me/goals/#{slug}/datapoints.json"
       datapoints = info.map{|d| Datapoint.new d}
 
       datapoints
@@ -98,7 +97,7 @@ module Beeminder
         "datapublic" => @datapublic || false,
       }
 
-      @user.put "users/#{@user.name}/goals/#{@slug}.json", data
+      @user.put "users/me/goals/#{@slug}.json", data
     end
 
     # Send new road setting to Beeminder.
@@ -109,7 +108,7 @@ module Beeminder
 
       dials["goaldate"] = dials["goaldate"].strftime('%s') unless dials["goaldate"].nil?
 
-      @user.post "users/#{@user.name}/goals/#{@slug}/dial_road.json", dials
+      @user.post "users/me/goals/#{@slug}/dial_road.json", dials
     end
     
     # Add one or more datapoints to the goal.
@@ -124,7 +123,7 @@ module Beeminder
           "sendmail"   => opts[:sendmail] || false
         }.merge(dp.to_hash)
 
-        @user.post "users/#{@user.name}/goals/#{@slug}/datapoints.json", data
+        @user.post "users/me/goals/#{@slug}/datapoints.json", data
       end
     end
 
@@ -134,7 +133,7 @@ module Beeminder
     def delete datapoints
       datapoints = [*datapoints]
       datapoints.each do |dp|
-        @user.delete "/users/#{@user.name}/goals/#{@slug}/datapoints/#{dp.id}.json"
+        @user.delete "/users/me/goals/#{@slug}/datapoints/#{dp.id}.json"
       end
     end
 
@@ -151,6 +150,21 @@ module Beeminder
         "datapublic" => @datapublic || false,
       }
     end
+
+    private
+
+    def _parse_info info
+      # set variables
+      info.each do |k,v|
+        instance_variable_set "@#{k}", v
+      end
+
+      # some conversions
+      @goaldate   = DateTime.strptime(@goaldate.to_s,   '%s') 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')
+    end
   end
 
   class Datapoint
@@ -180,7 +194,7 @@ module Beeminder
       @comment   ||= ""
 
       # some conversions
-      @timestamp  = DateTime.strptime(@timestamp.to_s,  '%s') unless @timestamp.is_a? Date
+      @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?
     end
 

data/lib/beeminder/user.rb

@@ -13,13 +13,31 @@ module Beeminder
 
     # @return [String] Timezone.
     attr_reader :timezone
-    
-    def initialize name, token
-      @name  = name
-      @token = token
 
-      info = get "users/#{@name}.json"
+    # @return [Symbol] Type of user, can be `:personal` (default) or `:oauth`.
+    attr_reader :auth_type
+    
+    def initialize token, opts={}
+      opts = {
+        :auth_type => :personal,
+      }.merge(opts)
+      
+      @token     = token
+      @auth_type = opts[:auth_type]
+
+      @token_type =
+        case @auth_type
+        when :personal
+          "auth_token"
+        when :oauth
+          "access_token"
+        else
+          raise ArgumentError, "Auth type not supported, must be :personal or :oauth."
+        end
       
+      info = get "users/me.json"
+
+      @name       = info["username"]
       @timezone   = info["timezone"]
       @updated_at = DateTime.strptime(info["updated_at"].to_s, '%s')
     end
@@ -31,10 +49,10 @@ module Beeminder
     def goals filter=:all
       raise "invalid goal filter: #{filter}" unless [:all, :frontburner, :backburner].include? filter
 
-      info = get "users/#{@name}.json", :filter => filter.to_s
-      goals = info["goals"].map do |goal|
-        Beeminder::Goal.new self, goal
-      end unless info["goals"].nil?
+      goals = get("users/#{@name}/goals.json", :filter => filter.to_s) || []
+      goals.map! do |info|
+        Beeminder::Goal.new self, info
+      end
 
       goals || []
     end
@@ -102,7 +120,7 @@ module Beeminder
     # Establish HTTPS connection to API.
     def _connection type, cmd, data
       api  = "https://www.beeminder.com/api/v1/#{cmd}"
-      data = {"auth_token" => @token}.merge(data)
+      data = {@token_type => @token}.merge(data)
       
       url = URI.parse(api)
       http = Net::HTTP.new(url.host, url.port)
@@ -128,7 +146,7 @@ module Beeminder
         
         res = http.request(req)
         if not res.is_a? Net::HTTPSuccess
-          raise "request #{cmd} / #{data} failed: #{res.code} / #{res.body}"
+          raise "request failed: #{res.code} / #{res.body}"
         end
 
         json = res.body

data/lib/beeminder/version.rb

@@ -1,3 +1,3 @@
 module Beeminder
-  VERSION = "0.1.9"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beeminder
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2547600853104850137
+      hash: 585995790058277298
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2547600853104850137
+      hash: 585995790058277298
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23