tickspot 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+tmp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Kreeftmeijer
+
+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.textile

@@ -0,0 +1,3 @@
+h1. Tickspot
+
+The Tickspot Ruby API wrapper.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tickspot"
+    gem.summary = %Q{The Tickspot Ruby API wrapper.}
+    gem.description = %Q{The Tickspot Ruby API wrapper.}
+    gem.email = "jeff@kreeftmeijer.nl"
+    gem.homepage = "http://github.com/jeffkreeftmeijer/tickspot"
+    gem.authors = ["Jeff Kreeftmeijer"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tickspot.rb

@@ -0,0 +1,146 @@
+require 'rubygems'
+require 'httparty'
+
+module Tickspot
+  class << self
+    attr_accessor :company, :email, :password
+  end
+
+  class Request
+
+    ##
+    # Send a post request to Tickspot. Will use Tickspot.company and
+    # Tickspot.section to build the url and passes every op tion it received (
+    # merged with Tickspot.email and Tickspot.password ) to HTTParty's :query
+    # parameter. It'll return everythin within the returned root node ( which
+    # is named equally to the section name ).
+    #
+    # @param [Hash] options The options you want to pass.
+    #
+    # @return [Array] items An array of hashes with the item data.
+
+    def self.post(options)
+      section = options.delete(:section)
+      result = HTTParty.post(
+        "https://#{Tickspot.company}.tickspot.com/api/#{section}",
+        :query => options.merge({
+          :email =>     Tickspot.email,
+          :password =>  Tickspot.password
+        })
+      )
+      result[section.to_s]
+    end
+  end
+
+  class Base
+    attr_reader :attributes
+
+    ##
+    # Create a new Tickspot::Base object. Will put the data provided in
+    # the @attributes attribute.
+    #
+    # @param [Hash] data The item's data.
+    #
+    # @return [Tickspot::Base] object The created object.
+
+    def initialize(data)
+      @attributes = data
+    end
+
+    ##
+    # Fetch the missing methods. Will fetch all missing methods executed on a
+    # Tickspot::Base object and use the method_id as a key to find a value in
+    # the object's @attributes. If the value found is an Array, it'll create a
+    # wrap it into a new object using the name to determine which one.
+    #
+    # @param [symbol] method_id The name of the missing method.
+    # @param [*] *args Additional arguments.
+    #
+    # @return [*] value The found value.
+
+    def method_missing(method_id, *args)
+      value = @attributes[method_id.to_s]
+      if value.is_a? Array
+        return value.map do |item|
+          self.class.sections.index(method_id).new(item)
+        end
+      end
+      value
+    end
+
+    ##
+    # The item id. Will return @attributes['id']
+    #
+    # @return [Integer] id The item id
+
+    def id
+      @attributes['id']
+    end
+    
+    ##
+    # The object section. Needs to be called by an extending class. Will get
+    # the section (to be passed to Tickspot in the url) from self.sections 
+    # using the constant name.
+    #
+    # @return [Symbol] section The object section
+    
+    def self.section
+      sections[self]
+    end
+
+    ##
+    # Fetch all items and return them in an array of objects. Will get the
+    # section using self.section (so Tickspot::Base needs to be extended) and
+    # merge that with any passed arguments to pass to Request.post. Every hash
+    # in the returned array will get wrapped in an item object.
+    #
+    # @return [Array] items An array of item objects.
+
+    def self.all(options = {})
+      result = Request.post(
+        options.merge({
+          :section => section
+        })
+      )
+      result.map{|item| new(item)} if result
+    end
+
+    ##
+    # The list to convert constant names to section symbols.
+    #
+    # @return [Hash] sections The list of sections.
+
+    def self.sections
+      {
+        Tickspot::Client =>             :clients,
+        Tickspot::Project =>            :projects,
+        Tickspot::Task =>               :tasks,
+        Tickspot::ClientProjectTask =>  :clients_projects_tasks,
+        Tickspot::Entry =>              :entries,
+        Tickspot::RecentTask =>         :recent_tasks,
+        Tickspot::User =>               :users,
+        Tickspot::CreateEntry =>        :create_entry,
+        Tickspot::UpdateEntry =>        :update_entry
+      }
+    end
+  end
+ 
+  class Client < Base; end
+  
+  class Project < Base; end
+
+  class Task < Base; end
+
+  class ClientProjectTask < Base; end
+  
+  class Entry < Base; end
+
+  class RecentTask < Base; end
+
+  class User < Base; end
+
+  class CreateEntry < Base; end
+
+  class UpdateEntry < Base; end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tickspot'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/tickspot_spec.rb

@@ -0,0 +1,188 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Tickspot do
+  it 'should set the company' do
+    Tickspot.company = 'c0mp4ny'
+    Tickspot.company.should == 'c0mp4ny'
+  end
+  
+  it 'should set the email' do
+    Tickspot.email = 'my@email.com'
+    Tickspot.email.should == 'my@email.com'
+  end
+  
+  it 'should set the password' do
+    Tickspot.password = 'secret'
+    Tickspot.password.should == 'secret'
+  end
+end
+
+describe Tickspot::Request do
+  describe '.post' do
+    before do
+      @result = {'tests' => []}
+    end
+    
+    it 'should do a post request with the parameters' do
+      HTTParty.should_receive(:post).with(
+        'https://c0mp4ny.tickspot.com/api/tests',
+        :query => {
+          :email =>     'my@email.com',
+          :password =>  'secret'
+        }
+      ).and_return(@result)
+
+      Tickspot::Request.post(
+        :section => :tests
+      )
+    end
+
+    it 'should pass every argument in the query hash' do
+      HTTParty.should_receive(:post).with(
+        'https://c0mp4ny.tickspot.com/api/tests',
+        :query => {
+          :email =>     'my@email.com',
+          :password =>  'secret',
+          :woo =>       'bleh'
+        }
+      ).and_return(@result)
+
+      Tickspot::Request.post(
+        :section =>   :tests,
+        :woo =>       'bleh'
+      )
+    end
+    
+    it 'should strip the top level node' do
+      HTTParty.stub!(:post).and_return(@result)
+      
+      Tickspot::Request.post(
+        :section => :tests
+      ).should == []
+    end
+  end
+end
+
+describe Tickspot::Base do
+  before do
+    class BaseTest < Tickspot::Base
+      def self.section
+        :tests
+      end
+    end
+    
+    @test = BaseTest.new({'id' => 14, 'name' => 'test!'})
+  end
+  
+  describe '#new' do
+    it 'should set the attributes' do
+      @test.attributes.should == {'id' => 14, 'name' => 'test!'}
+    end
+  end
+  
+  describe '#method_missing' do
+    it 'should find the attribute' do
+      @test.name.should == 'test!'
+    end
+    
+    it 'should turn nested hashes into objects' do
+      test = BaseTest.new({
+        'id' =>   14,
+        'name' => 'test!',
+        'clients' => [
+          {
+            'id' =>   15,
+            'name' => 'nested'
+          }
+        ]
+      })
+      test.clients.should be_instance_of Array
+      test.clients.length.should == 1
+      test.clients.each do |client|
+        client.should be_instance_of Tickspot::Client
+      end
+    end
+  end
+  
+  describe '#id' do
+    it 'should return the "id" attribute' do
+      @test.id.should == 14
+    end
+  end
+  
+  describe '.all' do    
+    it 'should send a request' do
+      Tickspot::Request.should_receive(:post).with(
+        :section => :tests
+      )
+      BaseTest.all
+    end
+    
+    it 'should pass the arguments' do
+      Tickspot::Request.should_receive(:post).with(
+        :section => :tests,
+        :project_id => 14
+      )
+      BaseTest.all(:project_id => 14)
+    end
+    
+    it 'should return BaseTest objects' do
+      Tickspot::Request.stub!(:post).and_return([{:id => 123}])
+      BaseTest.all.first.should be_instance_of BaseTest      
+    end
+  end
+end
+
+describe Tickspot::Client do
+  it 'should have :clients as its section' do
+    Tickspot::Client.section.should == :clients
+  end
+end
+
+describe Tickspot::Project do
+  it 'should have :projects as its section' do
+    Tickspot::Project.section.should == :projects
+  end
+end
+
+describe Tickspot::Task do
+  it 'should have :tasks as its section' do
+    Tickspot::Task.section.should == :tasks
+  end
+end
+
+describe Tickspot::ClientProjectTask do
+  it 'should have :clients_projects_tasks as its section' do
+    Tickspot::ClientProjectTask.section.should == :clients_projects_tasks
+  end
+end
+
+describe Tickspot::Entry do
+  it 'should have :entries as its section' do
+    Tickspot::Entry.section.should == :entries
+  end
+end
+
+describe Tickspot::RecentTask do
+  it 'should have :recent_tasks as its section' do
+    Tickspot::RecentTask.section.should == :recent_tasks
+  end
+end
+
+describe Tickspot::User do
+  it 'should have :users as its section' do
+    Tickspot::User.section.should == :users
+  end
+end
+
+describe Tickspot::CreateEntry do
+  it 'should have :create_entry as its section' do
+    Tickspot::CreateEntry.section.should == :create_entry
+  end
+end
+
+describe Tickspot::UpdateEntry do
+  it 'should have :update_entry as its section' do
+    Tickspot::UpdateEntry.section.should == :update_entry
+  end
+end

data/tickspot.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tickspot}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Kreeftmeijer"]
+  s.date = %q{2010-02-09}
+  s.description = %q{The Tickspot Ruby API wrapper.}
+  s.email = %q{jeff@kreeftmeijer.nl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/tickspot.rb",
+     "spec/spec_helper.rb",
+     "spec/tickspot_spec.rb",
+     "tickspot.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jeffkreeftmeijer/tickspot}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{The Tickspot Ruby API wrapper.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/tickspot_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: tickspot
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Kreeftmeijer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The Tickspot Ruby API wrapper.
+email: jeff@kreeftmeijer.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/tickspot.rb
+- spec/spec_helper.rb
+- spec/tickspot_spec.rb
+- tickspot.gemspec
+has_rdoc: true
+homepage: http://github.com/jeffkreeftmeijer/tickspot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: The Tickspot Ruby API wrapper.
+test_files: 
+- spec/spec_helper.rb
+- spec/tickspot_spec.rb