beeminder 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in beeminder-gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1 @@
+Do whatever you want. This is just a simple convenience gem, not some military secret.

data/README

@@ -0,0 +1,47 @@
+# Beeminder
+
+Convenient access to [Beeminder](http://www.beeminder.com)'s API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'beeminder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beeminder-gem
+
+## Usage
+
+First, get your token [here](https://www.beeminder.com/api/v1/auth_token.json) and log in:
+
+    bee = Beeminder::User.new "username", "token"
+
+Now you can do a bunch of stuff. You'll probably want to send a new datapoint:
+
+    # short form
+    bee.send "weight", 86.3
+
+    # long form
+    goal = bee.goal "weight"
+    dp = Beeminder::Datapoint.new :value => 86.3, :comment => "I loves cheeseburgers :3"
+    goal.add dp
+
+Or you can find all goals of a certain type:
+
+    odometer_goals = bee.goals.select {|g| g.goal_type == :biker}
+
+Or maybe show the last updated graph in a widget somewhere:
+
+   puts bee.goals.max_by(:updated_at).graph_url
+
+There's also a simple tool called `beemind` to update graphs:
+
+   $ beemind pushups 4
+
+Check the [gem doc]() and [API](https://www.beeminder.com/api-docs) for what else you can do.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,6 @@
+* TODO [3/5]
+- [X] document code
+- [ ] handle oauth tokens?
+- [X] beemind binary
+- [X] implement actual API calls
+- [ ] add a few more sanity checks

data/beeminder.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beeminder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "beeminder"
+  gem.version       = Beeminder::VERSION
+  gem.authors       = ["muflax"]
+  gem.email         = ["mail@muflax.com"]
+  gem.description   = "Convenient access to Beeminder's API."
+  gem.summary       = "access Beeminder API"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'highline', '~> 1.6'
+end

data/bin/beemind

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'yaml'
+
+# load library
+file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+lib = File.join File.dirname(file), "/../lib/beeminder"
+
+if File.exists? lib
+  # using local version
+  require lib
+else
+  require 'beeminder'
+end
+
+config = "#{Dir.home}/.beeminderrc"
+if not File.exists? config
+  # create config
+  require 'highline/import'
+  yaml = {
+    "account" => ask("Beeminder account:"),
+    "token"   => ask("Auth token:")
+  }
+  File.open(config, "w+") {|f| YAML.dump yaml, f}
+  File.chmod 0600, config
+  puts "Written config to '#{config}.'"
+end
+
+# load config
+yaml = YAML.load File.open(config)
+
+# login
+bee = Beeminder::User.new yaml["account"], yaml["token"]
+
+if not (2..3).include? ARGV.size
+  puts "usage: beemind goal value [comment]"
+  exit 1
+end
+
+goal, value, comment = ARGV
+
+bee.send goal, value, comment || ""

data/lib/beeminder.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+require 'date'
+require 'json'
+require 'net/https'
+require 'uri'
+
+# local libs
+Dir["#{File.join(File.dirname(__FILE__), "beeminder")}/*.rb"].each do |lib|
+  require lib
+end

data/lib/beeminder/goals.rb

@@ -0,0 +1,198 @@
+# coding: utf-8
+
+module Beeminder
+  class Goal
+    # @return [String] The final part of the URL of the goal, used as an identifier.
+    attr_accessor :slug
+
+    # @return [DateTime] Last time this goal was updated.
+    attr_reader :updated_at
+
+    # @return [String] The title that the user specified for the goal. 
+    attr_accessor :title
+
+    # @return [DateTime] Goal date.
+    attr_reader :goaldate
+
+    # @return [Numeric] Goal value.
+    attr_reader :goalval
+
+    # @return [Numeric] The slope of the (final section of the) yellow brick road.
+    attr_reader :rate
+
+    # @return [Symbol] One of the following symbols:
+    #   - `:fatloser`: Weight loss
+    #   - `:hustler`: Do More
+    #   - `:biker`: Odometer
+    #   - `:inboxer`: Inbox Fewer
+    #   - `:gainer`: Gain Weight
+    #   - `:drinker`: Set a Limit
+    #   - `:custom`: Full access to the underlying goal parameters
+    attr_reader :goal_type
+
+    # @return [DateTime] Date of derailment.
+    attr_reader :losedate
+
+    # @return [String] URL for the goal's graph image.
+    attr_reader :graph_url
+
+    # @return [Numeric] Panic threshold. How long before derailment to panic.
+    attr_accessor :panic
+
+    # @return [true|false] Whether the graph is currently being updated to reflect new data.
+    attr_reader :queued
+
+    # @return [true|false] Whether the graph was created in test mode.
+    attr_accessor :ephem
+
+    # @return [true|false] Whether you have to be signed in as owner of the goal to view it.
+    attr_accessor :secret
+
+    # @return [true|false] Whether you have to be signed in as the owner of the goal to view the datapoints.
+    attr_accessor :datapublic
+
+    # @return [Beeminder::User] User that owns this goal.
+    attr_reader :user
+    
+    def initialize user, name
+      @user = user
+      @slug = name
+      
+      reload
+    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')
+    end
+
+    # List of datapoints.
+    #
+    # @return [Array<Beeminder::Datapoint>] returns list of datapoints
+    def datapoints
+      info = @user.get "users/#{@user.name}/goals/#{slug}/datapoints.json"
+      datapoints = info.map{|d| Datapoint.new d}
+
+      datapoints
+    end
+
+    # Send updated meta-data to Beeminder.
+    def update
+      data = {
+        "slug"       => @slug,
+        "title"      => @title,
+        "ephem"      => @ephem || false,
+        "panic"      => @panic || 86400,
+        "secret"     => @secret || false,
+        "datapublic" => @datapublic || false,
+      }
+
+      @user.put "users/#{@user.name}/goals/#{@slug}.json", data
+    end
+
+    # Send new road setting to Beeminder.
+    #
+    # @param dials [Hash] Set exactly two of `"rate"`, `"goaldate"` and `"goalval"`. The third is implied.
+    def dial_road dials={}
+      raise "Set exactly two dials." if dials.keys.size != 2
+
+      dials["goaldate"] = dials["goaldate"].strftime('%s') unless dials["goaldate"].nil?
+
+      @user.post "users/#{@user.name}/goals/#{@slug}/dial_road.json", dials
+    end
+    
+    # Add one or more datapoints to the goal.
+    #
+    # @param datapoints [Beeminder::Datapoint, Array<Beeminder::Datapoint>] one or more datapoints to add to goal
+    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|
+        data = {
+          "sendmail"   => opts[:sendmail] || false
+        }.merge(dp.to_hash)
+
+        @user.post "users/#{@user.name}/goals/#{@slug}/datapoints.json", data
+      end
+    end
+
+    # Delete one or more datapoints from the goal.
+    #
+    # @param datapoints [Beeminder::Datapoint, Array<Beeminder::Datapoint>] one or more datapoints to delete
+    def delete datapoints
+      datapoints = [*datapoints]
+      datapoints.each do |dp|
+        @user.delete "/users/#{@user.name}/goals/#{@slug}/datapoints/#{dp.id}.json"
+      end
+    end
+
+    # Convert datapoint to hash for POSTing.
+    # @return [Hash]
+    def to_hash
+      {
+        "slug"       => @slug,
+        "title"      => @title,
+        "goal_type"  => @goal_type.to_s,
+        "ephem"      => @ephem || false,
+        "panic"      => @panic || 86400,
+        "secret"     => @secret || false,
+        "datapublic" => @datapublic || false,
+      }
+    end
+  end
+
+  class Datapoint
+    # @return [DateTime] Time of the datapoint.
+    attr_accessor :timestamp
+
+    # @return [Numeric] Value of the datapoint.
+    attr_accessor :value
+
+    # @return [String] An optional comment about the datapoint.
+    attr_accessor :comment
+
+    # @return [String] A unique ID, used to identify a datapoint when deleting or editing it.
+    attr_reader :id
+
+    # @return [DateTime] The time that this datapoint was entered or last updated.
+    attr_reader :updated_at
+
+    def initialize info
+      default = {
+        timestamp: DateTime.now.strftime('%s')
+      }
+      info = default.merge(info)
+      
+      # set variables
+      info.each do |k,v|
+        instance_variable_set "@#{k}", v
+      end
+
+      # some conversions
+      @timestamp  = DateTime.strptime(@timestamp.to_s,  '%s')
+      @updated_at = DateTime.strptime(@updated_at.to_s, '%s') unless @updated_at.nil?
+    end
+
+    # Convert datapoint to hash for POSTing.
+    # @return [Hash]
+    def to_hash
+      {
+        "timestamp" => @timestamp.strftime('%s'),
+        "value"     => @value || 0,
+        "comment"   => @comment || "",
+      }
+    end
+  end
+end

data/lib/beeminder/user.rb

@@ -0,0 +1,142 @@
+# coding: utf-8
+
+module Beeminder
+  class User
+    # @return [String] User name.
+    attr_reader :name
+
+    # @return [String] Auth token.
+    attr_reader :token
+
+    # @return [DateTime] Last time user made any changes.
+    attr_reader :updated_at
+
+    # @return [String] Timezone.
+    attr_reader :timezone
+    
+    def initialize name, token
+      @name  = name
+      @token = token
+
+      info = get "users/#{@name}.json"
+      
+      @timezone   = info["timezone"]
+      @updated_at = DateTime.strptime(info["updated_at"].to_s, '%s')
+    end
+
+    # List of goals.
+    #
+    # @param filter [Symbol] filter goals, can be `:all` (default), `:frontburner` or `:backburner`
+    # @ return [Array<Beeminder::Goal>] returns list of goals
+    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 || []
+    end
+
+    # Return specific goal.
+    #
+    # @param name [String] Name of the goal.
+    # @return [Beeminder::Goal] Returns goal.
+    def goal name
+      Beeminder::Goal.new self, name
+    end
+
+    # Convenience function to add datapoint to a goal.
+    #
+    # @param name [String] Goal name.
+    # @param value [Numeric] Datapoint value.
+    # @param comment [String] Optional comment.
+    def send name, value, comment=""
+      goal = self.goal name
+      dp = Beeminder::Datapoint.new value: value, comment: comment
+      goal.add dp
+    end
+    
+    # Create new goal.
+    #
+    # @param opts [Hash] Goal options.
+    def create_goal opts={}
+      post "users/#{@name}/goals.json", opts
+    end
+
+    # Send GET request to API.
+    #
+    # @param cmd [String] the API command, like `users/#{user.name}.json`
+    # @param data [Hash] data to send; auth_token is included by default (optional)
+    def get cmd, data={}
+      _connection :get, cmd, data
+    end
+
+    # Send POST request to API.
+    #
+    # @param cmd [String] the API command, like `users/#{user.name}.json`
+    # @param data [Hash] data to send; auth_token is included by default (optional)
+    def post cmd, data={}
+      _connection :post, cmd, data
+    end
+
+    # Send DELETE request to API.
+    #
+    # @param cmd [String] the API command, like `users/#{user.name}.json`
+    # @param data [Hash] data to send; auth_token is included by default (optional)
+    def delete cmd, data={}
+      _connection :delete, cmd, data
+    end
+
+    # Send PUT request to API.
+    #
+    # @param cmd [String] the API command, like `users/#{user.name}.json`
+    # @param data [Hash] data to send; auth_token is included by default (optional)
+    def put cmd, data={}
+      _connection :put, cmd, data
+    end
+
+    private
+
+    # Establish HTTPS connection to API.
+    def _connection type, cmd, data
+      api  = "https://www.beeminder.com/api/v1/#{cmd}"
+      data = {"auth_token" => @token}.merge(data)
+      
+      url = URI.parse(api)
+      http = Net::HTTP.new(url.host, url.port)
+      http.read_timeout = 8640
+      http.use_ssl = true
+
+      json = ""
+      http.start do |http|
+        req = case type
+              when :post
+                Net::HTTP::Post.new(url.path)
+              when :get
+                Net::HTTP::Get.new(url.path)
+              when :delete
+                Net::HTTP::Delete.new(url.path)
+              when :put
+                Net::HTTP::Put.new(url.path)
+              else
+                raise "invalid connection type"
+              end
+        req.set_form_data(data)
+        
+        res = http.request(req)
+        if not res.is_a? Net::HTTPSuccess
+          raise "request failed: #{res.body}"
+        end
+
+        json = res.body
+      end
+
+      # parse json
+      json = JSON.load(json)
+
+      json
+    end
+  end
+end

data/lib/beeminder/version.rb

@@ -0,0 +1,3 @@
+module Beeminder
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: beeminder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- muflax
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Convenient access to Beeminder's API.
+email:
+- mail@muflax.com
+executables:
+- beemind
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README
+- Rakefile
+- TODO
+- beeminder.gemspec
+- bin/beemind
+- lib/beeminder.rb
+- lib/beeminder/goals.rb
+- lib/beeminder/user.rb
+- lib/beeminder/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 350792412057985642
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 350792412057985642
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: access Beeminder API
+test_files: []