tickspot-rb 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_STORE
+.Trashes
+.rvmrc
+Gemfile.lock
+coverage/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in tickspot-rb.gemspec
+gemspec
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7.6'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Mason
+
+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/README.md

@@ -0,0 +1,43 @@
+# Tickspot-rb
+
+Ruby wrapper for the [Tick API](http://www.tickspot.com/api/).
+
+## Installation
+
+    $ gem install tickspot-rb
+
+## Example Usage
+
+    require 'tickspot'
+    
+    tick = Tickspot::Client.new('myCompanyName', 'myemail@example.com', 'myTickPassword')    
+    tick.clients
+
+    => [{"id"=>123, "name"=>"Acme"}, {"id"=>231, "name"=>"Sterling Cooper"}, {"id"=>321, "name"=>"Justice League"}]
+
+You can also initialize the client with a configuration block:
+
+    # config/initializers/tickspot.rb (for instance)
+    Tickspot.configure do |config|
+      config.company = 'acme'
+      config.email = 'wilie@acme.com'
+      config.password = 'secret'
+    end
+    
+    # elsewhere
+    client = Tickspot::Client.new
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Chris Mason. See LICENSE for details.

data/Rakefile

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

data/lib/tickspot.rb

@@ -0,0 +1,25 @@
+module Tickspot
+  
+  class << self
+    attr_accessor :company, :email, :password
+
+    # config/initializers/tickspot.rb (for instance)
+    #
+    # Tickspot.configure do |config|
+    #   config.company = 'acme'
+    #   config.email = 'wilie@acme.com'
+    #   config.password = 'secret'
+    # end
+    #
+    # elsewhere
+    #
+    # client = Tickspot::Client.new
+    def configure
+      yield self
+      true
+    end
+  end
+  
+  autoload :Client,  "tickspot/client"
+  autoload :Version, "tickspot/version"
+end

data/lib/tickspot/client.rb

@@ -0,0 +1,146 @@
+require 'httparty'
+require 'hashie'
+
+module Tickspot
+
+  class Client
+    include HTTParty
+    attr_reader :company, :email, :password
+
+    def initialize(company = Tickspot.company, email = Tickspot.email, password = Tickspot.password)
+      @company  = company
+      @email    = email
+      @password = password
+      
+      self.class.base_uri "https://#{@company}.tickspot.com/api"
+    end
+    # The clients method will return a list of all clients 
+    # and can only be accessed by admins on the subscription.
+    #
+    # Optional paramaters:
+    #   open => [true|false]
+    #
+    def clients(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/clients", :query => options)["clients"].map {|obj| Hashie::Mash.new obj }
+    end
+    
+    # The projects method will return projects filtered by the parameters provided. 
+    # Admin can see all projects on the subscription, 
+    # while non-admins can only access the projects they are assigned.
+    #
+    # Optional parameters:
+    #   project_id
+    #   open [true|false]
+    #   project_billable [true|false]
+    #
+    def projects(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/projects", :query => options)["projects"].map {|obj| Hashie::Mash.new obj }
+    end
+
+    # The tasks method will return a list of all the current tasks for a specified project 
+    # and can only be accessed by admins on the subscription.
+    #
+    # Required parameters:
+    #   project_id
+    #
+    # Optional Parameters:
+    #   task_id
+    #   open [true|false]
+    #   task_billable [true|false]
+    #
+    def tasks(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/tasks", :query => options)["tasks"].map {|obj| Hashie::Mash.new obj }
+    end
+    
+    # The method will return a list of all clients, projects, and tasks 
+    # that are assigned to the user and available for time entries (open).
+    #
+    def clients_projects_tasks
+      self.class.post("/clients_projects_tasks", :query => {:email => @email, :password => @password})["clients"].map {|obj| Hashie::Mash.new obj }
+    end   
+    
+    # The entries method will return a list of all entries that meet the provided criteria. 
+    # Either a start and end date have to be provided or an updated_at time. 
+    # The entries will be in the start and end date range or they will be after 
+    # the updated_at time depending on what criteria is provided. 
+    # Each of the optional parameters will further filter the response.  
+    #
+    # Required parameters:
+    #   start_date
+    #   end_date	
+    # OR	
+    #  updated_at
+    #
+    # Optional Parameters:
+    #   project_id
+    #   task_id
+    #   user_id
+    #   user_email
+    #   client_id
+    #   entry_billable [true|false]
+    #   billed [true|false]
+    #
+    def entries(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/entries", :query => options)["entries"].map {|obj| Hashie::Mash.new obj }
+    end
+    
+    # The users method will return a list of the most recently used tasks. 
+    # This is useful for generating quick links for a user to select a task they have been using recently.
+    #
+    def recent_tasks
+      self.class.post("/recent_tasks", :query => {:email => @email, :password => @password})['recent_tasks'].map {|obj| Hashie::Mash.new obj }
+    end
+    
+    # The users method will return a list of users.
+    #
+    # Optional parameters:
+    #   project_id
+    #
+    def users(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/users", :query => options)['users'].map {|obj| Hashie::Mash.new obj }
+    end
+    
+    # The create_entry method will accept a time entry for a specified task_id 
+    # and return the created entry along with the task and project stats.
+    #
+    # Require parameters:
+    #   task_id
+    #   hours
+    #   date
+    #
+    # Optional parameters:
+    #   notes
+    #
+    def create_entry(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/create_entry", :query => options)
+    end
+    
+    # The update_entry method will allow you to modify attributes of an existing entry. 
+    # The only required parameter is the id of the entry. 
+    # Additional parameters must be provided for any attribute that you wish to update. 
+    # For example, if you are only changing the billed attribute, 
+    # your post should only include the required parameters and the billed parameter.
+    #
+    # Require parameters:
+    #   id
+    #
+    # Optional parameters:
+    #   hours
+    #   date
+    #   billed
+    #   task_id
+    #   user_id
+    #   notes
+    #
+    def update_entry(options = {})
+      options.merge!(:email => @email, :password => @password)
+      self.class.post("/update_entry", :query => options)      
+    end
+  end
+end

data/lib/tickspot/version.rb

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

data/spec/client_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Tickspot::Client do
+  describe "instantiation" do
+    before(:each) do
+      Tickspot.configure do |config|
+        config.company = 'foo'
+        config.email = 'foo@example.com'
+        config.password = 'foo-secret'
+      end
+    end
+    
+    context "without arguments" do
+      let (:client) { Tickspot::Client.new }
+      it "uses credentials from Tickspot" do
+        client.company.should == 'foo'
+        client.email.should == 'foo@example.com'
+        client.password.should == 'foo-secret'
+      end
+    end
+    
+    context "with arguments" do
+      let (:client) { Tickspot::Client.new('bar', 'bar@example.com', 'bar-secret') }
+      it "uses the passed in credentials" do
+        client.company.should == 'bar'
+        client.email.should == 'bar@example.com'
+        client.password.should == 'bar-secret'
+      end      
+    end
+  end
+  
+  describe "accessing API" do
+    let (:client) { Tickspot::Client.new('bar', 'bar@example.com', 'bar-secret') }
+    
+    it "properly configures the base uri" do
+      client.class.base_uri.should == 'https://bar.tickspot.com/api'
+    end
+    
+    it "gets a list of clients" do
+      fake_post("clients")
+      results = client.clients
+      results.should have(3).clients
+      results.first.should be_an_instance_of(Hashie::Mash)
+    end
+
+    it "gets a list of users" do
+      fake_post("users")
+      results = client.users
+      results.should have(3).users
+      results.first.should be_an_instance_of(Hashie::Mash)
+    end
+
+    it "gets a list of projects" do
+      fake_post("projects")
+      results = client.projects
+      results.should have(1).project
+      results.first.should be_an_instance_of(Hashie::Mash)
+    end
+
+    it "gets a list of tasks" do
+      fake_post("tasks", {:project_id => 42})
+      results = client.tasks(:project_id => 42)
+      results.should have(1).task
+      results.first.should be_an_instance_of(Hashie::Mash)
+    end
+
+    it "gets a list of entries" do
+      fake_post("entries", {:updated_at => "2012-03-29"})
+      results = client.entries(:updated_at => "2012-03-29")
+      results.should have(1).entry
+      results.first.should be_an_instance_of(Hashie::Mash)
+    end
+  end
+end

data/spec/fixtures/clients.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clients type="array">
+  <client>
+    <id type="integer">12341</id>
+    <name>Starfleet Command</name>
+  </client>
+  <client>
+    <id type="integer">12342</id>
+    <name>The Vulcans</name>
+  </client>
+  <client>
+    <id type="integer">12343</id>
+    <name>The Cardassians</name>
+  </client>
+</clients>

data/spec/fixtures/entries.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entries type="array">
+  <entry>
+    <id type="integer">24</id>
+    <task_id type="integer">14</task_id>
+    <user_id type="integer">3</user_id>
+    <date type="date">2008-03-08</date>
+    <hours type="float">1.00</hours>
+    <notes>Had trouble with tribbles.</notes>
+    <billable>true</billable>
+    <billed>true</billed>
+    <created_at type="datetime">Tue, 07 Oct 2008 14:46:16 -0400</created_at>
+    <updated_at type="datetime">Tue, 07 Oct 2008 14:46:16 -0400</updated_at>
+    <user_email>scotty@enterprise.com</user_email>
+    <task_name>Remove converter assembly</task_name>
+    <sum_hours type="float">2.00</sum_hours>
+    <budget type="float">10.00</budget>
+    <project_name>Realign dilithium crystals</project_name>
+    <client_name>Starfleet Command</client_name>
+  </entry>
+</entries>

data/spec/fixtures/projects.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projects type="array">
+  <project>
+    <id type="integer">7</id>
+    <name>Realign dilithium crystals</name>
+    <budget type="float">50</budget>
+    <client_id type="integer">4</client_id>
+    <owner_id type="integer">14</owner_id>
+    <opened_on type="date">2006-01-01</opened_on>
+    <closed_on type="date"></closed_on>
+    <created_at type="datetime">Tue, 07 Oct 2008 14:46:16 -0400</created_at>
+    <updated_at type="datetime">Tue, 07 Oct 2008 14:46:16 -0400</updated_at>
+    <client_name>Starfleet Command</client_name>
+    <sum_hours type="float">22.5</sum_hours>
+    <user_count type="integer">2</user_count>
+    <tasks type="array">
+      <task>
+         <id type="integer">14</id>
+         <name>Remove converter assembly</name>
+         <position type="integer">1</position>
+         <project_id type="integer">2</project_id>
+         <opened_on type="date">2006-01-01</opened_on>
+         <closed_on type="date"></closed_on>
+         <budget type="float">50</budget>
+         <billable type="boolean">true</billable>
+         <sum_hours type="float">22.5</sum_hours>
+         <user_count type="integer">2</user_count>
+      </task>
+    </tasks>
+  </project>
+</projects>

data/spec/fixtures/tasks.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<tasks type="array">
+  <task>
+    <id type="integer">14</id>
+    <name>Remove converter assembly</name>
+    <position type="integer">1</position>
+    <project_id type="integer">2</project_id>
+    <opened_on type="date">2006-01-01</opened_on>
+    <closed_on type="date"></closed_on>
+    <budget type="float">50</budget>
+    <billable type="boolean">true</billable>
+    <sum_hours type="float">22.5</sum_hours>
+    <user_count type="integer">2</user_count>
+  </task>
+</tasks>

data/spec/fixtures/users.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<users type="array">
+  <user>
+    <id type="integer">64272</id>
+    <first_name>Bugs</first_name>
+    <last_name>Bunny</last_name>
+    <email>bugs@example.com</email>
+    <created_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</created_at>
+    <updated_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</updated_at>
+  </user>
+  <user>
+    <id type="integer">64272</id>
+    <first_name>Elmer</first_name>
+    <last_name>Fudd</last_name>
+    <email>elmer@example.com</email>
+    <created_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</created_at>
+    <updated_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</updated_at>
+  </user>
+  <user>
+    <id type="integer">64272</id>
+    <first_name>Daffy</first_name>
+    <last_name>Duck</last_name>
+    <email>daffy@example.com</email>
+    <created_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</created_at>
+    <updated_at type="datetime">Thu, 04 Nov 2010 17:31:06 -0400</updated_at>
+  </user>
+</users>

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'tickspot'
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  #
+end
+
+def fake_post(resource, params = {})
+  params.merge!(:email => 'bar@example.com', :password => 'bar-secret')
+  stub_request(:post, "https://bar.tickspot.com/api/#{resource}"
+              ).with(:query => params
+              ).to_return(:body => fixture_file("#{resource}.xml"), :status => 200, :headers => {'Content-Type' => 'application/xml'})
+end
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end

data/spec/tickspot_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Tickspot do
+
+  before(:each) do
+    Tickspot.company = nil
+    Tickspot.email = nil
+    Tickspot.password = nil
+  end
+
+  it "should be able to set the company" do
+    Tickspot.company = 'acme'
+    Tickspot.company.should == 'acme'
+  end
+
+  it "shoudl be able to set the email" do
+    Tickspot.email = 'my_email@example.com'
+    Tickspot.email.should == 'my_email@example.com'
+  end
+
+  it "should be able to set the password" do
+    Tickspot.password = 'double_secret_probation'
+    Tickspot.password.should == 'double_secret_probation'
+  end
+  it "should be able to set the company, email, and password via configuration block" do
+    Tickspot.configure do |config|
+      config.company  = 'acme'
+      config.email    = 'my_email@example.com'
+      config.password = 'double_secret_probation'
+    end
+
+    Tickspot.company.should  == 'acme'
+    Tickspot.email.should    == 'my_email@example.com'
+    Tickspot.password.should == 'double_secret_probation'
+  end
+end

data/tickspot-rb.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tickspot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tickspot-rb"
+  s.version     = Tickspot::VERSION
+  s.authors     = ["Chris Mason"]
+  s.email       = ["chris@chaione.com"]
+  s.homepage    = "https://github.com/cmason/tickspot-rb"
+  s.description = %q{Ruby wrapper for the Tick API  http://tickspot.com/api}
+  s.summary     = s.description
+
+  s.rubyforge_project = "tickspot-rb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency 'hashie'
+  s.add_runtime_dependency 'httparty'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: tickspot-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70120337962020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120337962020
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70120337961280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120337961280
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70120337960600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120337960600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70120337959840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120337959840
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70120337959380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120337959380
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70120337958600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120337958600
+description: Ruby wrapper for the Tick API  http://tickspot.com/api
+email:
+- chris@chaione.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tickspot.rb
+- lib/tickspot/client.rb
+- lib/tickspot/version.rb
+- spec/client_spec.rb
+- spec/fixtures/clients.xml
+- spec/fixtures/entries.xml
+- spec/fixtures/projects.xml
+- spec/fixtures/tasks.xml
+- spec/fixtures/users.xml
+- spec/spec_helper.rb
+- spec/tickspot_spec.rb
+- tickspot-rb.gemspec
+homepage: https://github.com/cmason/tickspot-rb
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tickspot-rb
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Tick API  http://tickspot.com/api
+test_files:
+- spec/client_spec.rb
+- spec/fixtures/clients.xml
+- spec/fixtures/entries.xml
+- spec/fixtures/projects.xml
+- spec/fixtures/tasks.xml
+- spec/fixtures/users.xml
+- spec/spec_helper.rb
+- spec/tickspot_spec.rb