sox 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sox (0.0.1)
+    sox (0.0.2)
       bubble-wrap (~> 1.3.0)
 
 GEM

data/README.md

@@ -31,7 +31,7 @@ Currenly Sox only supports basic authentication using your Freshbooks API token
 You can retrieve your Freshbooks API token from the 'My Account' page on Freshbooks.
 
 ```ruby
-@client = Sox::Client 'your-freshbooks-subdomain', 'api-token'
+@client = Sox::Client.new 'your-freshbooks-subdomain', 'api-token'
 ```
 
 You can then use your client object to perform the CRUD operations on Freshbooks.
@@ -54,8 +54,8 @@ This is a very early release. All the base classes and supporting classes should
 * Add integration tests for real API data
 * Support for OAuth authentication
 
-* Clients (create, update, get, delete)
-* Projects (create, update, get, delete)
+* Clients (update, get, delete)
+* Projects (update, get, delete)
 * Categories (create, update, get, delete, list)
 * Estimates (create, update, get, delete, list, sendByEmail)
 * Categories (create, update, get, delete, list)
@@ -70,9 +70,9 @@ This is a very early release. All the base classes and supporting classes should
 * Recurring (create, update, get, delete, list)
 * Recurring Items (add, delete, update)
 * Staff (current, get, list)
-* Tasks (create, update, get, delete)
-* Taxes (create, update, get, delete)
-* Time entries (create, update, get, delete)
+* Tasks (create, update, get, delete, list)
+* Taxes (create, update, get, delete, list)
+* Time entries (update, get, delete)
 
 ## Contributing
 

data/lib/sox/client.rb

@@ -20,5 +20,9 @@ module Sox
     def projects
       proxy(:project)
     end
+
+    def time_entries
+      proxy(:time_entry)
+    end
   end
 end

data/lib/sox/request_options.rb

@@ -28,12 +28,11 @@ module Sox
         parent = NSXMLElement.alloc.initWithName(key)
         value.each do |k, v|
           el = generate_xml_node parent, k, v
-          element.addChild el
         end
       else
         el = NSXMLElement.alloc.initWithName(key, stringValue: value.to_s)
-        element.addChild el
       end
+      element.addChild el
       element
     end
   end

data/lib/sox/restful_operation.rb

@@ -9,7 +9,17 @@ module Sox
     end
 
     def all(options={}, &block)
-      payload = RequestOptions.new("#{@prefix}.list", options).request
+      post("#{@prefix}.list", options, &block)
+    end
+
+    def create(options={}, &block)
+      post("#{@prefix}.create", options, &block)
+    end
+
+    private
+
+    def post(path, options, &block)
+      payload = RequestOptions.new(path, options).request
       opts = { credentials: @auth }
       opts.merge!({ payload: payload })
       BW::HTTP.post(@base_url, opts) do |response|

data/lib/sox/version.rb

@@ -1,4 +1,4 @@
 module Sox
   API_VERSION = '2.1'
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/fixtures/all_clients_successful_response.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <response xmlns="http://www.freshbooks.com/api/" status="ok">
   <clients page="1" per_page="25" pages="1" total="2">
     <client>

data/spec/fixtures/all_projects_successful_response.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <response xmlns="http://www.freshbooks.com/api/" status="ok">
   <projects page="1" per_page="15" pages="1" total="2">
     <project>

data/spec/fixtures/all_time_entries_successful_response.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="ok">
+  <time_entries page="1" per_page="15" pages="10" total="2">
+    <time_entry>
+      <time_entry_id>211</time_entry_id>
+      <staff_id>1</staff_id>
+      <project_id>1</project_id>
+      <task_id>1</task_id>
+      <hours>2</hours>
+      <date>2009-03-13</date>
+      <notes>Sample Notes</notes>
+      <billed>0</billed>   <!-- 1 or 0 (Read Only) -->
+    </time_entry>
+    <time_entry>
+    </time_entry>
+  </time_entries>
+</response>

data/spec/fixtures/new_client_successful_response.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="ok">
+  <client_id>13</client_id>
+</response>

data/spec/fixtures/new_project_successful_response.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="ok">
+  <project_id>15</project_id>
+</response>

data/spec/fixtures/new_time_entry_successful_response.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="ok">
+  <time_entry_id>211</time_entry_id>
+</response>

data/spec/lib/sox/client_spec.rb

@@ -29,6 +29,12 @@ describe Sox::Client do
     end
   end
 
+  describe '#time_entries' do
+    it 'returns a proxy object' do
+      @client.time_entries.prefix.should == :time_entry
+    end
+  end
+
   it 'can have multiple proxies' do
     @client.clients.prefix.should == :client
     @client.projects.prefix.should == :project

data/spec/lib/sox/clients_operations_spec.rb

@@ -25,4 +25,35 @@ describe 'Freshbooks API clients operations' do
       response[:clients][:client][1][:first_name][:data].should == 'John'
     end
   end
+
+  it 'can create a new client' do
+    body = load_fixture('new_client_successful_response.xml')
+    stub_request(:post, @client.base_url).to_return body: body, content_type: 'application/xml'
+
+    request = { client: {
+      first_name: 'Jane',
+      last_name: 'Doe',
+      organization: 'ABC Corp',
+      username: 'janedoe',
+      contacts: {
+        contact: {
+          username: 'alex',
+          first_name: '',
+          last_name: '',
+          email: 'test@freshbooks.com'
+        }
+      }
+    } }
+
+    @client.clients.create(request) do |r|
+      @response = r
+      resume
+    end
+    wait_max 1.0 do
+      response = @response[:response]
+      response[:status].should == 'ok'
+      response[:client_id][:data].should == '13'
+    end
+  end
+
 end

data/spec/lib/sox/projects_operations_spec.rb

@@ -24,4 +24,36 @@ describe 'Freshbooks API projects operations' do
       response[:projects][:project][0][:client_id][:data].should == '119'
     end
   end
+
+  it 'can create a new project' do
+    body = load_fixture('new_project_successful_response.xml')
+    stub_request(:post, @client.base_url).to_return body: body, content_type: 'application/xml'
+
+    request = { project: {
+      name: 'Website Redesign',
+      bill_method: 'project-rate',
+      client_id: 21,
+      rate: 45.00,
+      description: 'A new website for ABC Corp',
+      tasks: {
+        task: {
+          task_id: 5
+        },
+        task: {
+          task_id: 3
+        }
+      }
+    } }
+
+    @client.projects.create(request) do |r|
+      @response = r
+      resume
+    end
+    wait_max 1.0 do
+      response = @response[:response]
+      response[:status].should == 'ok'
+      response[:project_id][:data].should == '15'
+    end
+  end
+
 end

data/spec/lib/sox/request_options_spec.rb

@@ -18,4 +18,9 @@ describe Sox::RequestOptions do
     request = Sox::RequestOptions.new('client.list', { client: { address: { street: '123 Main St.' } } }).request
     request.should == '<request method="client.list"><client><address><street>123 Main St.</street></address></client></request>'
   end
+
+  it 'converts a converts a child list to xml' do
+    request = Sox::RequestOptions.new('client.list', { client: { attribute_one: 1, attribute_two: 2 } }).request
+    request.should == '<request method="client.list"><client><attribute_one>1</attribute_one><attribute_two>2</attribute_two></client></request>'
+  end
 end

data/spec/lib/sox/time_entries_operations_spec.rb

@@ -0,0 +1,48 @@
+describe 'Freshbooks API time entries operations' do
+  extend WebStub::SpecHelpers
+  extend SpecHelper
+
+  before do
+    disable_network_access!
+    @client = Sox::Client.new 'fake', '12345'
+  end
+
+  it 'can fetch all of the time entries' do
+    body = load_fixture('all_time_entries_successful_response.xml')
+    stub_request(:post, @client.base_url).to_return body: body, content_type: 'application/xml'
+
+    @client.time_entries.all do |r|
+      @response = r
+      resume
+    end
+    wait_max 1.0 do
+      response = @response[:response]
+      response[:status].should == 'ok'
+      response[:time_entries][:total].should == '2'
+      response[:time_entries][:time_entry][0][:project_id][:data].should == '1'
+      response[:time_entries][:time_entry][0][:hours][:data].should == '2'
+    end
+  end
+
+  it 'can create a new time entry' do
+    body = load_fixture('new_time_entry_successful_response.xml')
+    stub_request(:post, @client.base_url).to_return body: body, content_type: 'application/xml'
+
+    request = { time_entry: {
+      project_id: 1,
+      task_id: 1,
+      hours: 4.5,
+      notes: 'Phone consultation'
+    } }
+
+    @client.time_entries.create(request) do |r|
+      @response = r
+      resume
+    end
+    wait_max 1.0 do
+      response = @response[:response]
+      response[:status].should == 'ok'
+      response[:time_entry_id][:data].should == '211'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -101,10 +101,15 @@ files:
 - spec/_spec_helper.rb
 - spec/fixtures/all_clients_successful_response.xml
 - spec/fixtures/all_projects_successful_response.xml
+- spec/fixtures/all_time_entries_successful_response.xml
+- spec/fixtures/new_client_successful_response.xml
+- spec/fixtures/new_project_successful_response.xml
+- spec/fixtures/new_time_entry_successful_response.xml
 - spec/lib/sox/client_spec.rb
 - spec/lib/sox/clients_operations_spec.rb
 - spec/lib/sox/projects_operations_spec.rb
 - spec/lib/sox/request_options_spec.rb
+- spec/lib/sox/time_entries_operations_spec.rb
 - spec/lib/sox/xml_parser_spec.rb
 homepage: 
 licenses: []
@@ -120,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2815329898089102049
+      hash: 3723447028891806663
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2815329898089102049
+      hash: 3723447028891806663
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -140,8 +145,13 @@ test_files:
 - spec/_spec_helper.rb
 - spec/fixtures/all_clients_successful_response.xml
 - spec/fixtures/all_projects_successful_response.xml
+- spec/fixtures/all_time_entries_successful_response.xml
+- spec/fixtures/new_client_successful_response.xml
+- spec/fixtures/new_project_successful_response.xml
+- spec/fixtures/new_time_entry_successful_response.xml
 - spec/lib/sox/client_spec.rb
 - spec/lib/sox/clients_operations_spec.rb
 - spec/lib/sox/projects_operations_spec.rb
 - spec/lib/sox/request_options_spec.rb
+- spec/lib/sox/time_entries_operations_spec.rb
 - spec/lib/sox/xml_parser_spec.rb