freckle 0.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem "rest-client", "1.6.1"
+gem "json", "1.4.6"
+
+group :test do
+  gem "fakeweb", "1.3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    json (1.4.6)
+    mime-types (1.16)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb (= 1.3.0)
+  json (= 1.4.6)
+  rest-client (= 1.6.1)

data/README.textile

@@ -0,0 +1,41 @@
+h1. Freckle
+
+A simple RestClient-based Let's Freckle API client.
+
+Only supports reading data.
+
+h2. Example
+
+Freckle.establish_conection(:account => "apitest",
+                            :token => "lx3gi6pxdjtjn57afp8c2bv1me7g89j")
+
+project = Freckle::Project.all.first
+project.entries
+
+h2. TODO
+
+* CRUD
+
+h2. License
+
+The MIT License
+
+Copyright (c) 2010 Matt Todd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/freckle.rb

@@ -0,0 +1,110 @@
+# http://github.com/madrobby/freckle-apidocs
+
+require 'logger'
+
+require 'rest_client'
+require 'json'
+
+class Freckle
+  def initialize(options = {})
+    @account  = options.delete(:account)
+    @token    = options.delete(:token)
+    @logger   = options.delete(:logger) || Logger.new(STDOUT)
+    RestClient.log = @logger
+    @connection = RestClient::Resource.new( "http://#{@account}.letsfreckle.com/api",
+                                            :headers => {"X-FreckleToken" => @token} )
+  end
+  
+  def self.establish_connection(options)
+    @connection = new(options)
+  end
+  def self.connection
+    return @connection if @connection
+    raise RuntimeError, "Freckle.establish_connection with :account and :token first"
+  end
+  
+  ### Query Methods
+  
+  def users(options = {})
+    Array(JSON.parse(@connection['/users.json'].get)).flatten.map do |user|
+      User.new(user['user'], self)
+    end
+  end
+  
+  def projects(options = {})
+    Array(JSON.parse(@connection['/projects.json'].get)).flatten.map do |project|
+      Project.new(project['project'], self)
+    end
+  end
+  
+  # people: comma separated user ids
+  # projects: comma separated project ids
+  # tags: comma separated tag ids
+  # from: entries from this date
+  # to: entries to this date
+  # billable: true only shows billable entries; false only shows unbillable entries
+  def entries(options = {})
+    options.keys.each { |k| options["search[#{k}]"] = Array(options.delete(k)).flatten.join(',') }
+    Array(JSON.parse(@connection['/entries.json'].get(:params => options))).flatten.map do |entry|
+      Entry.new(entry['entry'], self)
+    end
+  end
+  
+  ### Models
+  
+  class Base
+    include Comparable
+    attr_reader :attributes
+    def initialize(attributes, connection = nil)
+      @connection = connection
+      @attributes = attributes
+    end
+    def id
+      @attributes['id']
+    end
+    def method_missing(method_name, *args)
+      return @attributes[method_name.to_s] if @attributes.key?(method_name.to_s)
+      super
+    end
+    def self.all(key = nil, options = {})
+      raise ArgumentError, "key is required" if key.nil?
+      Freckle.connection.send(key, options)
+    end
+    def self.first(options = {})
+      self.all(options).first
+    end
+    def <=>(other)
+      [self.class, self.id] <=> [other.class, other.id]
+    end
+  end
+  
+  class User < Base
+    def self.all(options = {})
+      super(:users, options)
+    end
+  end
+  
+  class Project < Base
+    def self.all(options = {})
+      super(:projects, options)
+    end
+    def entries(options = {})
+      projects = (options.delete(:projects) || [])
+      projects.push(self.id) unless projects.include?(self.id)
+      @connection.entries(options.merge(:projects => projects))
+    end
+  end
+  
+  class Entry < Base
+    def self.all(options = {})
+      super(:entries, options)
+    end
+    def project(options = {})
+      @connection.projects(options).detect{ |project| project.id == self.project_id }
+    end
+    def user(options = {})
+      @connection.users(options).detect{ |user| user.id == self.user_id }
+    end
+  end
+  
+end

data/test/fixtures/entries.json

@@ -0,0 +1,14 @@
+[
+  {"entry":{"created_at":"2010-07-22T10:02:00Z","billable":true,"minutes":240,"updated_at":"2010-07-22T10:02:00Z","recently_updated_at":"2010-07-22T10:02:00Z","project_id":8475,"url":null,"time_to":null,"id":311207,"date":"2010-07-24","user_id":5543,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-07-21T10:10:54Z","billable":true,"minutes":120,"updated_at":"2010-07-21T10:10:54Z","recently_updated_at":"2010-07-21T10:10:54Z","project_id":19618,"url":null,"time_to":null,"id":309459,"date":"2010-07-21","user_id":5543,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-07-21T09:48:13Z","billable":true,"minutes":15,"updated_at":"2010-07-21T09:48:13Z","recently_updated_at":"2010-07-21T09:48:13Z","project_id":19618,"url":null,"time_to":null,"id":309421,"date":"2010-07-21","user_id":5543,"formatted_description":"","description_text":null,"time_from":null,"description":"foobar","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-07-22T09:34:09Z","billable":true,"minutes":180,"updated_at":"2010-07-22T09:34:09Z","recently_updated_at":"2010-07-22T09:34:09Z","project_id":19618,"url":null,"time_to":null,"id":311146,"date":"2010-07-21","user_id":5538,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-07-21T09:49:13Z","billable":true,"minutes":15,"updated_at":"2010-07-21T09:49:13Z","recently_updated_at":"2010-07-21T09:49:13Z","project_id":19618,"url":null,"time_to":null,"id":309427,"date":"2010-07-21","user_id":5538,"formatted_description":"","description_text":null,"time_from":null,"description":"foobar","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-07-22T09:30:01Z","billable":true,"minutes":180,"updated_at":"2010-07-22T09:30:01Z","recently_updated_at":"2010-07-22T09:30:01Z","project_id":19618,"url":null,"time_to":null,"id":311144,"date":"2010-07-21","user_id":5543,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-06-17T18:25:34Z","billable":true,"minutes":120,"updated_at":"2010-06-17T18:25:34Z","recently_updated_at":"2010-06-17T18:25:34Z","project_id":19618,"url":null,"time_to":null,"id":259336,"date":"2010-06-17","user_id":5543,"formatted_description":null,"description_text":null,"time_from":null,"description":"","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-06-17T18:26:34Z","billable":true,"minutes":120,"updated_at":"2010-06-17T18:26:34Z","recently_updated_at":"2010-06-17T18:26:34Z","project_id":8475,"url":null,"time_to":null,"id":259339,"date":"2010-06-17","user_id":5543,"formatted_description":"","description_text":null,"time_from":null,"description":"new tag, other tag","invoiced_at":null,"project_invoice_id":null}}
+]

data/test/fixtures/entries_for_project.json

@@ -0,0 +1,10 @@
+[
+  {"entry":{"created_at":"2010-07-21T10:10:54Z","billable":true,"minutes":120,"updated_at":"2010-07-21T10:10:54Z","recently_updated_at":"2010-07-21T10:10:54Z","project_id":19618,"url":null,"time_to":null,"id":309459,"date":"2010-07-21","user_id":5543,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-07-21T09:48:13Z","billable":true,"minutes":15,"updated_at":"2010-07-21T09:48:13Z","recently_updated_at":"2010-07-21T09:48:13Z","project_id":19618,"url":null,"time_to":null,"id":309421,"date":"2010-07-21","user_id":5543,"formatted_description":"","description_text":null,"time_from":null,"description":"foobar","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-07-22T09:34:09Z","billable":true,"minutes":180,"updated_at":"2010-07-22T09:34:09Z","recently_updated_at":"2010-07-22T09:34:09Z","project_id":19618,"url":null,"time_to":null,"id":311146,"date":"2010-07-21","user_id":5538,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-07-21T09:49:13Z","billable":true,"minutes":15,"updated_at":"2010-07-21T09:49:13Z","recently_updated_at":"2010-07-21T09:49:13Z","project_id":19618,"url":null,"time_to":null,"id":309427,"date":"2010-07-21","user_id":5538,"formatted_description":"","description_text":null,"time_from":null,"description":"foobar","invoiced_at":null,"project_invoice_id":null}},
+  
+  {"entry":{"created_at":"2010-07-22T09:30:01Z","billable":true,"minutes":180,"updated_at":"2010-07-22T09:30:01Z","recently_updated_at":"2010-07-22T09:30:01Z","project_id":19618,"url":null,"time_to":null,"id":311144,"date":"2010-07-21","user_id":5543,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-06-17T18:25:34Z","billable":true,"minutes":120,"updated_at":"2010-06-17T18:25:34Z","recently_updated_at":"2010-06-17T18:25:34Z","project_id":19618,"url":null,"time_to":null,"id":259336,"date":"2010-06-17","user_id":5543,"formatted_description":null,"description_text":null,"time_from":null,"description":"","invoiced_at":null,"project_invoice_id":null}}
+]

data/test/fixtures/entries_for_user.json

@@ -0,0 +1,4 @@
+[
+  {"entry":{"created_at":"2010-07-22T09:34:09Z","billable":true,"minutes":180,"updated_at":"2010-07-22T09:34:09Z","recently_updated_at":"2010-07-22T09:34:09Z","project_id":19618,"url":null,"time_to":null,"id":311146,"date":"2010-07-21","user_id":5538,"formatted_description":"freckle restful api test","description_text":null,"time_from":null,"description":"freckle restful api test","invoiced_at":null,"project_invoice_id":null}},
+  {"entry":{"created_at":"2010-07-21T09:49:13Z","billable":true,"minutes":15,"updated_at":"2010-07-21T09:49:13Z","recently_updated_at":"2010-07-21T09:49:13Z","project_id":19618,"url":null,"time_to":null,"id":309427,"date":"2010-07-21","user_id":5538,"formatted_description":"","description_text":null,"time_from":null,"description":"foobar","invoiced_at":null,"project_invoice_id":null}}
+]

data/test/fixtures/projects.json

@@ -0,0 +1,4 @@
+[
+  {"project":{"name":"A new Company","created_at":"2010-06-08T00:53:20Z","billable":true,"updated_at":"2010-06-08T00:53:20Z","account_id":5039,"id":19618,"enabled":true,"user_id":null,"budget":null,"stepping":15,"invoice_recipient_details":null}},
+  {"project":{"name":"Fixture Company","created_at":"2009-10-16T09:04:50Z","billable":true,"updated_at":"2009-11-01T14:54:39Z","account_id":5039,"id":8475,"enabled":true,"user_id":null,"budget":null,"stepping":5,"invoice_recipient_details":null}}
+]

data/test/fixtures/users.json

@@ -0,0 +1,3 @@
+[
+  {"user":{"id":5538,"last_name":"Freckle","time_format":"fraction","login":"admin","first_name":"Lets","email":"apitestadmin@letsfreckle.com"}}
+]

data/test/freckle_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+class FreckleTest < Test::Unit::TestCase
+  
+  def setup
+    @logger = Logger.new(File.join(File.dirname(__FILE__), 'test.log'))
+    @connection = Freckle.new(:account  => @account = "test",
+                              :token    => @token   = "test",
+                              :logger   => @logger)
+  end
+  
+  def teardown
+    Freckle.send(:instance_variable_set, :@connection, nil)
+  end
+  
+  ### Query Methods
+  
+  def test_users
+    assert !@connection.users.empty?
+  end
+  
+  def test_projects
+    assert !@connection.projects.empty?
+  end
+  
+  def test_entries
+    assert !@connection.entries.empty?
+  end
+  
+  ### Models
+  
+  def test_users_return_user_model
+    assert user = @connection.users.first
+    assert user.is_a?(Freckle::User)
+  end
+  
+  def test_projects_return_project_model
+    assert project = @connection.projects.first
+    assert project.is_a?(Freckle::Project)
+  end
+  
+  def test_entries_return_entry_model
+    assert entry = @connection.entries.first
+    assert entry.is_a?(Freckle::Entry)
+  end
+  
+  def test_user_model_attributes_are_available_as_methods
+    assert user = @connection.users.first
+    assert_equal user.id,         user.attributes['id']
+    assert_equal user.first_name, user.attributes['first_name']
+    assert_equal user.last_name,  user.attributes['last_name']
+  end
+  
+  ### Associations
+  
+  def test_project_model_can_query_for_its_entries
+    assert project = @connection.projects.first
+    project.entries.each do |entry|
+      assert_equal project, entry.project
+    end
+  end
+  
+  ### Filtering
+  
+  def test_entries_can_filter_by_user
+    assert user     = @connection.users.first
+    assert project  = @connection.projects.first
+    @connection.entries(:people => [user.id]).each do |entry|
+      assert_equal user, entry.user
+    end
+  end
+  
+  ### Singleton Connection
+  
+  def test_user_all_without_established_connection_raises_error
+    assert_raise RuntimeError, /establish_connection/ do
+      Freckle::User.all
+    end
+  end
+  
+  def test_user_all_matches_users
+    Freckle.establish_connection(:account => @account, :token => @token, :logger => @logger)
+    assert_equal @connection.users, Freckle::User.all
+  end
+  
+  def test_user_first_matches_first_user
+    Freckle.establish_connection(:account => @account, :token => @token, :logger => @logger)
+    assert_equal @connection.users.first, Freckle::User.first
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "bundler/setup"
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'freckle')
+
+require 'test/unit'
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+
+{ "http://test.letsfreckle.com/api/users.json"    => "users",
+  "http://test.letsfreckle.com/api/projects.json" => "projects",
+  "http://test.letsfreckle.com/api/entries.json"  => "entries",
+  "http://test.letsfreckle.com/api/entries.json?search[projects]=19618" => "entries_for_project",
+  "http://test.letsfreckle.com/api/entries.json?search[people]=5538"    => "entries_for_user"
+}.each do |(uri, fixture)|
+  FakeWeb.register_uri(:get, uri, :body => File.read(File.join(File.dirname(__FILE__), "fixtures", "%s.json" % fixture)))
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: freckle
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Let's Freckle API Client
+email: mtodd@highgroove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.textile
+- Rakefile
+- lib/freckle.rb
+- test/fixtures/entries.json
+- test/fixtures/entries_for_project.json
+- test/fixtures/entries_for_user.json
+- test/fixtures/projects.json
+- test/fixtures/users.json
+- test/freckle_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/freckly
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Let's Freckle API
+test_files: 
+- test/freckle_test.rb
+- test/test_helper.rb