quaderno 1.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", ">= 1.0.0"
+  gem 'debugger'
+  gem 'httparty'
+  gem "jeweler", "~> 1.8.4"
+  gem "shoulda", ">= 0"
+  gem "rcov", "~> 0.9.11" #">= 0"
+  gem "rdoc", "~> 3.12"
+  gem 'vcr', :require => 'vcr'
+end
+
+group :test do
+  gem 'debugger', :require => 'ruby-debug'
+  gem 'fakeweb'
+  gem 'vcr', :require => 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    columnize (0.3.6)
+    debugger (1.2.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.4)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.4)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+    vcr (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  debugger
+  fakeweb
+  httparty
+  jeweler (~> 1.8.4)
+  rcov (~> 0.9.11)
+  rdoc (~> 3.12)
+  shoulda
+  vcr

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Carlos Hernandez
+
+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,264 @@
+# Quaderno-ruby
+
+Quaderno-ruby is a ruby wrapper for [quaderno api] (https://github.com/recrea/quaderno-api).
+
+As the api, it's mostly crud.
+
+## Installation & Configuration
+
+To install add the following to your Gemfile:
+
+```ruby
+	gem 'quaderno-ruby', require 'quaderno-ruby'
+```
+
+To configure just add this to your initializers
+
+```ruby
+	Quaderno::Base.configure do |config|
+		config.auth_token = 'my_authenticate_token'
+		config.subdomain = 'my_account_subdomain'
+	end
+```
+
+## Ping the service
+ You can ping the service in order to check if it is up with: 
+ 
+```ruby
+  Quaderno::Base.ping #=> Boolean
+```
+
+This will return true if the service is up or false if it is not.
+
+## Check the rate limit
+
+```ruby
+  Quaderno::Base.rate_limit_info #=>  { :limit => 100, :remaining => 100 }
+```
+
+This will return a hash with information about the rate limit and your remaining requestes
+
+## Reading the values
+
+Quaderno-ruby parses all the json responses in human readable data, so you can access each value just like this:
+
+```ruby
+  contact.id 
+  invoice.items
+  estimates.payments
+  etc.
+```
+
+## Managing contacts
+ 
+### Getting contacts
+```ruby
+ Quaderno::Contact.all(1) #=> Array
+```
+
+ will return an array with all your contacts on the first page.
+ 
+### Finding a contact
+```ruby
+ Quaderno::Contact.find(id) #=> Quaderno::Contact
+```
+
+will return the contact with the id passed as parameter.
+
+### Creating a new contact
+```ruby
+ Quaderno::Contact.create(params) #=> Quaderno::Contact
+```
+
+will create a contact using the information of the hash passed as parameter and return an instance of Quaderno::Contact with the created contact.
+
+### Updating an existing contact
+```ruby
+ Quaderno::Contact.update(id, params) #=> Quaderno::Contact
+```
+
+will update the specified contact with the data of the hash passed as second parameter.
+
+### Deleting a contact
+```ruby
+  Quaderno::Contact.delete(id) #=> Boolean
+```
+
+will delete the contact with the id passed as parameter.
+
+ 
+## Managing invoices
+
+### Getting invoices
+```ruby
+  Quaderno::Invoice.all(1) #=> Array
+```
+
+ will return an array with all your invoices on the first page.
+ 
+### Finding an invoice
+```ruby
+  Quaderno::Invoice.find(id) #=> Quaderno::Invoice
+```
+
+will return the invoice with the id passed as parameter.
+
+### Creating a new invoice
+
+```ruby
+  Quaderno::Invoice.create(params) #=> Quaderno::Invoice
+```
+
+will create an invoice using the information of the hash passed as parameter.
+
+### Updating an existing invoice
+```ruby
+  Quaderno::Invoice.update(id, params) #=> Quaderno::Invoice
+```
+
+will update the specified invoice with the data of the hash passed as second parameter.
+
+### Deleting an invoice
+
+```ruby
+  Quaderno::Invoice.delete(id) #=> Boolean
+```
+
+will delete the invoice with the id passed as parameter.
+
+ 
+###Adding or removing a payment
+ In order to  add a payment you will need the Invoice instance you want to update.
+ 
+```ruby
+  invoice = Quaderno::Invoice.find(invoice_id)
+  invoice.add_payment(params) #=> Quaderno::Payment
+```
+
+Where params is a hash with the payment information. The method will return the an instance of Quaderno::Payment wich contains the information of the payment.
+
+In order to  remove a payment you will need the Invoice instance you want to update.
+ 
+```ruby
+  invoice = Quaderno::Invoice.find(invoice_id)
+  invoice.remove_payment(payment_id) #=> Boolean
+``` 
+ 
+###Delivering the invoice
+
+  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+  
+```ruby
+  invoice = Quaderno::Invoice.find(invoice_id)
+  invoice.deliver
+```
+
+
+## Managing estimates
+
+
+### Getting estimates
+```ruby
+  Quaderno::Estimate.all(1) #=> Array
+```
+
+ will return an array with all your estimates on the first page.
+ 
+### Finding an estimate
+```ruby
+  Quaderno::Estimate.find(id) #=> Quaderno::Estimate
+```
+
+will return the estimate with the id passed as parameter.
+
+### Creating a new estimate
+
+```ruby
+  Quaderno::Estimate.create(params) #=> Quaderno::Estimate
+```
+
+will create an estimate using the information of the hash passed as parameter.
+
+### Updating an existing estimate
+```ruby
+  Quaderno::Estimate.update(id, params)
+```
+
+will update the specified estimate with the data of the hash passed as second parameter.
+
+### Deleting an estimate
+
+```ruby
+  Quaderno::Estimate.delete(id) #=> Boolean
+```
+
+will delete the estimate with the id passed as parameter.
+
+ 
+###Adding or removing a payment
+ In order to add a payment you will need the estimate you want to update.
+ 
+```ruby
+  estimate = Quaderno::Estimate.find(estimate_id)
+  estimate.add_payment(params) #=> Quaderno::Payment
+```
+
+Where params is a hash with the payment information. The method will return the an instance of Quaderno::Payment wich contains the information of the payment.
+
+In order to  remove a payment you will need the estimate you want to update.
+ 
+```ruby
+  estimate = Quaderno::Estimate.find(estimate_id)
+  estimate.remove_payment(payment_id) #=> Boolean
+``` 
+ 
+###Delivering the estimate
+  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+  
+```ruby
+  estimate = Quaderno::Estimate.find(estimate_id)
+  estimate.deliver
+```
+
+ 
+## Managing expenses
+
+### Getting expenses
+```ruby
+ Quaderno::Expense.all(1) #=> Array
+```
+
+ will return an array with all your expenses on the first page.
+ 
+### Finding an expense
+```ruby
+ Quaderno::Expense.find(id) #=> Quaderno::Expense
+```
+
+will return the expense with the id passed as parameter.
+
+### Creating a new expense
+```ruby
+ Quaderno::Expense.create(params) #=> Quaderno::Expense
+```
+
+will create an expense using the information of the hash passed as parameter and return an instance of Quaderno::Expense with the created expense.
+
+### Updating an existing expense
+```ruby
+ Quaderno::Expense.update(id, params) #=> Quaderno::Expense
+```
+
+will update the specified expense with the data of the hash passed as second parameter.
+
+### Deleting an expense
+```ruby
+  Quaderno::Expense.delete(id) #=> Boolean
+```
+
+will delete the expense with the id passed as parameter.
+
+
+## Quaderno-api 
+
+For further information, please visit [quaderno api] (https://github.com/recrea/quaderno-api) wiki

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "quaderno"
+  gem.homepage = "http://github.com/recrea/quaderno-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{one-line summary of your gem}
+  gem.description = %Q{longer description of your gem}
+  gem.email = "carlos@recrea.es"
+  gem.authors = ["Recrea"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "quaderno-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/build_install.sh

@@ -0,0 +1,2 @@
+gem build quaderno-ruby.gemspec
+gem install quaderno-ruby-0.1.1.gem

data/lib/quaderno-ruby/base.rb

@@ -0,0 +1,71 @@
+module Quaderno
+  require 'httparty'
+  require 'json'
+  
+  class Base < OpenStruct
+    include HTTParty
+    include Quaderno::Exceptions
+    include Quaderno::Behavior::Crud    
+    
+    base_uri 'https://quadernoapp.com/'
+    @@auth_token = nil 
+    @@subdomain = nil
+    @@rate_limit_info = nil
+      
+    def self.api_model(klass)
+      instance_eval <<-END
+        def api_model
+          #{klass}
+        end
+      END
+      class_eval <<-END
+        def api_model
+          #{klass}
+        end
+      END
+    end
+    
+    #Default way to configure the authenticata data
+    def self.configure
+      yield self
+    end
+     
+    def self.auth_token=(auth_token)
+      @@auth_token = auth_token
+    end
+    
+    def self.subdomain=(subdomain)
+      @@subdomain = subdomain
+    end
+    
+    #Check the connection
+    def self.ping
+      begin
+        party_response = get("/#{ subdomain }/api/v1/ping.json", basic_auth: { username: auth_token })
+      rescue Errno::ECONNREFUSED
+        return false
+      end
+      true
+    end
+    
+    #Returns the rate limit information: limit and remaining requests
+    def self.rate_limit_info
+      party_response = get("/#{ subdomain }/api/v1/ping.json", basic_auth: { username: auth_token })
+      @@rate_limit_info = { limit: party_response.headers["x-ratelimit-limit"].to_i, remaining: party_response.headers["x-ratelimit-remaining"].to_i }
+    end
+    
+    
+    private 
+    def self.auth_token
+      @@auth_token
+    end
+    
+    def self.subdomain
+      @_subdomain = @@subdomain
+    end
+    #Set or returns the model path for the url
+    def self.api_path(api_path = nil)
+      @_api_path ||= api_path
+    end
+  end
+end

data/lib/quaderno-ruby/behavior/crud.rb

@@ -0,0 +1,83 @@
+require 'ruby-debug'
+module Quaderno
+  module Behavior
+    module Crud         
+      def self.included(receiver)
+        receiver.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def to_instance(klass, hash)
+          klass.new hash
+        end
+
+        def parse(element)
+          payments_collection = []
+          element['payments'].each do |payment|
+            payments_collection << api_model.to_instance(Quaderno::Payment, payment)
+          end unless api_model == Quaderno::Estimate
+          element['payments'] = payments_collection
+
+          items_collection = []
+          element['items'].each do |item|
+            items_collection << api_model.to_instance(Quaderno::Item, item)
+          end
+          element['items'] = items_collection
+
+          contact = api_model.to_instance(Quaderno::Contact, element['contact'])
+          element['contact'] = contact
+        end
+
+        def all(page_number)
+          party_response = get("/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }.json?page=#{page_number}", basic_auth: { username: api_model.auth_token })
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true })
+          array = JSON::parse party_response.body
+          collection = []
+          array.each do |element|  
+            if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
+              api_model.parse(element)
+            end
+            collection << (new element)
+          end          
+          collection
+        end
+
+        def find(id)
+          party_response = get "/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true })       
+          hash = JSON::parse party_response.body
+          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
+            api_model.parse(hash)
+          end
+          new hash          
+        end
+
+        def create(params)
+          party_response = post "/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }.json", body: params, basic_auth: { username: api_model.auth_token }
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, required_fields: true })
+          hash = JSON::parse party_response.body
+          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
+            api_model.parse(hash)
+          end
+          new hash
+        end
+
+        def update(id, params)
+          party_response = put "/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }.json", body: params, basic_auth: { username: api_model.auth_token }
+          check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true })
+          hash = JSON::parse party_response.body                        
+          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
+            api_model.parse(hash)
+          end
+          new hash
+        end
+
+        def delete(id)
+          party_response = HTTParty.delete "#{ api_model.base_uri }/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })         
+          true
+        end
+      end
+    end
+  end
+end

data/lib/quaderno-ruby/behavior/deliver.rb

@@ -0,0 +1,18 @@
+module Quaderno
+  module Behavior
+    module Deliver
+  
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+      
+      module InstanceMethods
+        def deliver
+          party_response = api_model.get("/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }/deliver.json", basic_auth: { username: api_model.auth_token })
+          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true, required_fields: true })
+          { limit: party_response.headers["x-ratelimit-limit"].to_i, remaining: party_response.headers["x-ratelimit-remaining"].to_i }
+        end 
+      end
+    end
+  end
+end

data/lib/quaderno-ruby/behavior/payment.rb

@@ -0,0 +1,38 @@
+module Quaderno
+  module Behavior
+    module Payment 
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+      
+      module InstanceMethods
+        def to_instance(klass, parsed)
+          klass.new(parsed)
+        end
+        
+        def add_payment(params)
+          party_response = api_model.post "/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }/payments.json", body: params, basic_auth: { username: api_model.auth_token }            
+          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
+          parsed = JSON::parse party_response.body
+          instance = to_instance(Quaderno::Payment, parsed)
+          payments << instance
+          Quaderno::Payment.new parsed
+        end
+
+        def remove_payment(payment_id)
+          party_response = HTTParty.delete "#{ api_model.base_uri }/#{ api_model.subdomain }/api/v1/#{ api_model.api_path }/#{ id }/payments/#{ payment_id }.json", basic_auth: { username: api_model.auth_token }
+          to_delete = nil
+          payments.each do |payment|
+            if payment.id == payment_id
+              to_delete = payment
+              break
+            end
+          end
+          payments.delete(to_delete)
+          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true }) 
+          true
+        end
+      end
+    end
+  end
+end

data/lib/quaderno-ruby/contact.rb

@@ -0,0 +1,8 @@
+module Quaderno
+  class Contact < Base
+    
+    api_model Quaderno::Contact
+    api_path 'contacts'
+    
+  end
+end

data/lib/quaderno-ruby/estimate.rb

@@ -0,0 +1,8 @@
+module Quaderno
+  class Estimate < Base
+    include Quaderno::Behavior::Deliver
+    
+    api_model Quaderno::Estimate
+    api_path 'estimates'
+  end
+end