activeresource-zoho_invoice 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72865f48ba14d0f22ca9d2529348420570c76992
+  data.tar.gz: 86a96cb3dadcfebf85268b6c5f59b347870d294f
+SHA512:
+  metadata.gz: 03b5ec9c02777457ece64c4bcf9cff9326545d21e3d17b5ad2ba193c1de7e8791d3677564280d054072ea4c90456acc1ff9d472610aa6da852706a89d76f1416
+  data.tar.gz: 0a55ed78d609db43b07b9a423bb76a8855e41da52ddeedcf03a481e1d09cd9e58b8114c96f7b5a8d04a8b7536d1ec02c90990dc2fb5031e42b3c8628b50a7138

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activeresource-zoho_invoice.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Toru KAWAMURA
+
+MIT License
+
+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,35 @@
+# ActiveResource Zoho Invoice
+
+Zoho Invoice API accessor with ActiveResource
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activeresource-zoho_invoice'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeresource-zoho_invoice
+
+## Usage
+
+    class Invoice < ZohoInvoiceResource::Invoice
+      self.auth_params = {
+        apikey:    'apikeyishere',
+        authtoken: 'authtokenishere',
+        scope:     'invoiceapi'
+      }
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/activeresource-zoho_invoice.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zoho_invoice_resource/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activeresource-zoho_invoice'
+  spec.version       = ZohoInvoiceResource::VERSION
+  spec.authors       = ['Toru KAWAMURA']
+  spec.email         = ['tkawa@4bit.net']
+  spec.description   = %q{Zoho Invoice API accessor with ActiveResource}
+  spec.summary       = %q{Zoho Invoice API accessor with ActiveResource}
+  spec.homepage      = 'https://github.com/tkawa/activeresource-zoho_invoice'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activeresource', '>= 4.0.0'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/activeresource-zoho_invoice.rb

@@ -0,0 +1 @@
+require 'zoho_invoice_resource'

data/lib/zoho_invoice_resource.rb

@@ -0,0 +1,19 @@
+require 'zoho_invoice_resource/version'
+require 'active_support'
+require 'active_resource'
+
+module ZohoInvoiceResource
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Invoice
+  autoload :Customer
+
+  autoload :Collection
+  autoload :Connection
+  autoload :Formats
+  autoload :UnderscoreKeys
+  autoload :Util
+
+  autoload :CachedResource
+end

data/lib/zoho_invoice_resource/base.rb

@@ -0,0 +1,85 @@
+require 'active_record/attribute_assignment'
+
+module ZohoInvoiceResource
+  class Base < ActiveResource::Base
+    include UnderscoreKeys
+    include ActiveRecord::AttributeAssignment
+
+    self.site = 'https://invoice.zoho.com/api/'
+    self.include_format_in_path = false
+    self.collection_parser = Collection
+    class_attribute :auth_params
+
+    class << self
+      def element_path(id, prefix_options = {}, query_options = {})
+        query_options.merge!(auth_params)
+        super(id, prefix_options, query_options)
+      end
+
+      def collection_path(prefix_options = {}, query_options = {})
+        query_options.merge!(auth_params)
+        super(prefix_options, query_options)
+      end
+
+      def find_all_recursively(options = {})
+        collection = find(:all, options.merge(params: {'Per_Page' => 500}))
+        while collection.page && (collection.page < collection.total_pages)
+          next_collection = find(:all, params: {'Page' => collection.page + 1, 'Per_Page' => 500})
+          collection.merge!(next_collection)
+        end
+        collection
+      rescue ActiveResource::ResourceNotFound
+        nil
+      end
+
+      def format
+        self._format ||= Formats::Base.new(self.to_s.demodulize)
+      end
+
+      # For CachedResource
+      def cached_resource(options={})
+        if defined?(CachedResource::Model) && self.include?(CachedResource::Model)
+          super.tap do
+            include CachedResourcePatch
+          end
+        end
+      end
+    end
+
+    def update
+      run_callbacks :update do
+        connection.post(self.class.custom_method_collection_url(:update, prefix_options), encode, self.class.headers).tap do |response|
+          load_attributes_from_response(response)
+        end
+      end
+    end
+
+    def update_element_path(options = nil)
+      self.class.element_path(to_param, options || prefix_options)
+    end
+
+    def encode(options={})
+      xml = self.class.format.encode(self, {:root => self.class.element_name}.merge(options))
+      URI.encode_www_form(self.class.auth_params.merge('XMLString' => xml))
+    end
+
+    def create_resource_for(resource_name)
+      super.tap do |resource|
+        resource.send(:include, UnderscoreKeys)
+        resource.send(:include, ActiveRecord::AttributeAssignment)
+      end
+    end
+
+    def self.connection(refresh = false)
+      @connection = Connection.new(site, format) if refresh || @connection.nil?
+      @connection.tap do |c|
+        c.proxy = proxy if proxy
+        c.user = user if user
+        c.password = password if password
+        c.auth_type = auth_type if auth_type
+        c.timeout = timeout if timeout
+        c.ssl_options = ssl_options if ssl_options
+      end
+    end
+  end
+end

data/lib/zoho_invoice_resource/cached_resource_patch.rb

@@ -0,0 +1,21 @@
+module ZohoInvoiceResource
+  module CachedResourcePatch
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # override
+      def cache_read(key)
+        object = cached_resource.cache.read(key)
+        # dupしないといけないのかも
+        object && cached_resource.logger.info("#{CachedResource::Configuration::LOGGER_PREFIX} READ #{key}")
+        object
+      end
+    end
+
+    def expire_cache
+      # TODO: 本当は個別に削除したい
+      # self.send(:update_singles_cache, self) して collectionのを削除するとか。
+      self.class.clear_cache
+    end
+  end
+end

data/lib/zoho_invoice_resource/collection.rb

@@ -0,0 +1,38 @@
+module ZohoInvoiceResource
+  class Collection < ActiveResource::Collection
+    attr_reader :page, :pages, :per_page, :total, :total_pages
+    def initialize(hash)
+      @element_hash = hash
+      if hash['PageContext']
+        @page = hash['PageContext']['Page'].to_i
+        @pages = [@page]
+        @per_page = hash['PageContext']['Per_Page'].to_i
+        @total = hash['PageContext']['Total'].to_i
+        @total_pages = hash['PageContext']['Total_Pages'].to_i
+      end
+    end
+
+    def elements
+      @elements ||= begin
+        name = resource_class.name
+        @element_hash[name.pluralize][name]
+      end
+    end
+
+    def collect!
+      elements # prepare @elements
+      super
+    end
+
+    def merge!(another)
+      another.each do |element|
+        elements << element
+      end
+      @pages = [@page, another.page].flatten
+      @page = another.page
+      @per_page = another.per_page
+      @total = another.total
+      @total_pages = another.total_pages
+    end
+  end
+end

data/lib/zoho_invoice_resource/connection.rb

@@ -0,0 +1,14 @@
+module ZohoInvoiceResource
+  class Connection < ActiveResource::Connection
+    DEBUG = true
+    def http
+      configure_http(new_http).tap do |h|
+        h.set_debug_output($stderr) if DEBUG
+      end
+    end
+
+    def http_format_header(http_method)
+      {HTTP_FORMAT_HEADER_NAMES[http_method] => format.mime_type(http_method)}
+    end
+  end
+end

data/lib/zoho_invoice_resource/customer.rb

@@ -0,0 +1,9 @@
+module ZohoInvoiceResource
+  class Customer < Base
+    self.primary_key = 'customer_id'
+
+    def self.format
+      self._format ||= Formats::Customer.new
+    end
+  end
+end

data/lib/zoho_invoice_resource/formats.rb

@@ -0,0 +1,7 @@
+module ZohoInvoiceResource
+  module Formats
+    autoload :Base, 'zoho_invoice_resource/formats/base'
+    autoload :Invoice, 'zoho_invoice_resource/formats/invoice'
+    autoload :Customer, 'zoho_invoice_resource/formats/customer'
+  end
+end

data/lib/zoho_invoice_resource/formats/base.rb

@@ -0,0 +1,48 @@
+require 'ostruct'
+
+module ZohoInvoiceResource
+  module Formats
+    class Base
+      include ActiveResource::Formats::XmlFormat
+
+      attr_reader :element_name
+      def initialize(element_name = nil)
+        @element_name = element_name || self.class.to_s.demodulize
+      end
+
+      def mime_type(http_method = :get)
+        if http_method == :post
+          'application/x-www-form-urlencoded'
+        else
+          'application/xml'
+        end
+      end
+
+      def decode(xml)
+        hash = ActiveResource::Formats.remove_root(Hash.from_xml(xml))
+        if hash['status'] == '1'
+          # success
+          # single record or collection
+          hash[element_name] || hash
+        else
+          # failure
+          api_response = OpenStruct.new(Util.underscore_keys(hash))
+          case api_response.code.to_i
+          when 1002
+            raise ActiveResource::ResourceNotFound.new(api_response)
+          else
+            raise ActiveResource::BadRequest.new(api_response)
+          end
+        end
+      end
+
+      def normalize_date(date)
+        if date.match %r|\d{4}/\d{2}/\d{2}|
+          date.tr('/', '-')
+        else
+          date
+        end
+      end
+    end
+  end
+end

data/lib/zoho_invoice_resource/formats/customer.rb

@@ -0,0 +1,34 @@
+module ZohoInvoiceResource
+  module Formats
+    class Customer < Base
+      def encode(record, options={})
+        options[:root] = options[:root].try(:camelize)
+        # updatable attributes restricted
+        data = {
+          'CustomerID'     => record.customer_id,
+          'Name'           => record.name,
+          'PaymentsDue'    => record.payments_due,
+          'BillingAddress' => record.billing_address,
+          'BillingCity'    => record.billing_city,
+          'BillingState'   => record.billing_state,
+          'BillingZip'     => record.billing_zip,
+          'BillingCountry' => record.billing_country,
+          'Notes'          => record.notes,
+          #'CustomFields'   => {}
+        }
+        data.to_xml(options).tapp
+      end
+
+      def decode(xml)
+        super.tap do |hash|
+          # avoid weird XML structure
+          %w(BillingAddress ShippingAddress).each do |attr_name|
+            if hash[attr_name].is_a?(Array)
+              hash[attr_name] = hash[attr_name].find{|value| value.is_a?(String)}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zoho_invoice_resource/formats/invoice.rb

@@ -0,0 +1,31 @@
+module ZohoInvoiceResource
+  module Formats
+    class Invoice < Base
+      def encode(record, options={})
+        options[:root] = options[:root].try(:camelize)
+        # updatable attributes restricted
+        data = {
+          'InvoiceID' => record.invoice_id,
+          'InvoiceDate' => normalize_date(record.invoice_date),
+          'DueDate' => normalize_date(record.due_date),
+          'InvoiceItems' => [],
+          'CustomFields' => {}
+        }
+        record.invoice_items.each do |invoice_item|
+          item = {
+            'ItemID' => invoice_item.item_id,
+            'ItemDescription' => invoice_item.item_description,
+            'Price' => invoice_item.price
+          }
+          data['InvoiceItems'] << item
+        end
+        data.delete('InvoiceItems') if data['InvoiceItems'].empty?
+        data['CustomFields']['CustomField1'] = record.custom_fields.custom_field1 if record.custom_fields.custom_label1
+        data['CustomFields']['CustomField2'] = record.custom_fields.custom_field2 if record.custom_fields.custom_label2
+        data['CustomFields']['CustomField3'] = record.custom_fields.custom_field3 if record.custom_fields.custom_label3
+        data.delete('CustomFields') if data['CustomFields'].empty?
+        data.to_xml(options)
+      end
+    end
+  end
+end

data/lib/zoho_invoice_resource/invoice.rb

@@ -0,0 +1,25 @@
+module ZohoInvoiceResource
+  class Invoice < Base
+    self.primary_key = 'invoice_id'
+
+    #schema do
+    #  integer :invoice_id
+    #
+    #end
+
+    def self.format
+      self._format ||= Formats::Invoice.new
+    end
+
+    def invoice_items_attributes=(attributes_collection)
+      attributes_collection.each do |attributes|
+        attributes = attributes.with_indifferent_access
+        if existing_item = self.invoice_items.find{|item| item.item_id == attributes[:item_id]}
+          existing_item.assign_attributes(attributes)
+        else
+          # TODO: raise error
+        end
+      end
+    end
+  end
+end

data/lib/zoho_invoice_resource/underscore_keys.rb

@@ -0,0 +1,37 @@
+module ZohoInvoiceResource
+  module UnderscoreKeys
+    def load(attributes, remove_root = false, persisted = false)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      attributes = Util.underscore_keys(attributes)
+      @prefix_options, attributes = split_options(attributes)
+
+      if attributes.keys.size == 1
+        remove_root = self.class.element_name == attributes.keys.first.to_s
+      end
+
+      attributes = ActiveResource::Formats.remove_root(attributes) if remove_root
+
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+          if value.is_a?(Array) ||
+            (value.is_a?(Hash) && value.keys.size == 1 && value = value.values.flatten)
+            resource = nil
+            value.map do |attrs|
+              if attrs.is_a?(Hash)
+                resource ||= find_or_create_resource_for_collection(key)
+                resource.new(attrs, persisted)
+              else
+                attrs.duplicable? ? attrs.dup : attrs
+              end
+            end
+          elsif value.is_a?(Hash)
+            resource = find_or_create_resource_for(key)
+            resource.new(value, persisted)
+          else
+            value.duplicable? ? value.dup : value
+          end
+      end
+      self
+    end
+  end
+end

data/lib/zoho_invoice_resource/util.rb

@@ -0,0 +1,21 @@
+module ZohoInvoiceResource
+  module Util
+    extend self
+
+    def underscore_keys(hash)
+      hash = hash.dup
+      hash.keys.each do |key|
+        hash[(key.to_s.underscore rescue key) || key] = hash.delete(key)
+      end
+      hash
+    end
+
+    def camelize_keys(hash)
+      hash = hash.dup
+      hash.keys.each do |key|
+        hash[(key.to_s.camelize rescue key) || key] = hash.delete(key)
+      end
+      hash
+    end
+  end
+end

data/lib/zoho_invoice_resource/version.rb

@@ -0,0 +1,3 @@
+module ZohoInvoiceResource
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: activeresource-zoho_invoice
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toru KAWAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Zoho Invoice API accessor with ActiveResource
+email:
+- tkawa@4bit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeresource-zoho_invoice.gemspec
+- lib/activeresource-zoho_invoice.rb
+- lib/zoho_invoice_resource.rb
+- lib/zoho_invoice_resource/base.rb
+- lib/zoho_invoice_resource/cached_resource_patch.rb
+- lib/zoho_invoice_resource/collection.rb
+- lib/zoho_invoice_resource/connection.rb
+- lib/zoho_invoice_resource/customer.rb
+- lib/zoho_invoice_resource/formats.rb
+- lib/zoho_invoice_resource/formats/base.rb
+- lib/zoho_invoice_resource/formats/customer.rb
+- lib/zoho_invoice_resource/formats/invoice.rb
+- lib/zoho_invoice_resource/invoice.rb
+- lib/zoho_invoice_resource/underscore_keys.rb
+- lib/zoho_invoice_resource/util.rb
+- lib/zoho_invoice_resource/version.rb
+homepage: https://github.com/tkawa/activeresource-zoho_invoice
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Zoho Invoice API accessor with ActiveResource
+test_files: []