einvoice 0.2.0 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d40d662bce05b0f05bff5b9b980a27abb5a1bb47
-  data.tar.gz: 43edf9033179b4475711025ba4a240e8fe2b116f
+  metadata.gz: e81da9d745a37edf6cd7d91ba444787a1ffd70fe
+  data.tar.gz: 5d3cbbd481ff54fb6b2ac53831d33a7f102864da
 SHA512:
-  metadata.gz: 80e76b8fd5a68e4c8c28547751d1f67a2c372b07912bba3ec2768143b73988a88024d17b30e3c9b2d41ed6d383542eb56d36b83ed395e9c49c6706917f79bbad
-  data.tar.gz: 283626dbf581277a1993eef18c6ffad7e666901219df18cd4cb4b031a93ecbb2b8087a48fe1f1488dccae634f254d9ec7b98f25f05f1384c65d04e74eaff0cb1
+  metadata.gz: b65eefa4b53987624bf1e242aa8321ed0ebef2af343ebb791a26d6630b9065604c97c66016162f12f36ed216c7d43a206b30d18b304bcca717a230277aa705e8
+  data.tar.gz: 933d45a596c8264294b582db2868d618097e62a647ab1fd0fa5c1d67078a0168844780cf70192ffef58b932f2506158f3c5bf3db1e32cb4b9a29ef9f9f3d6c3a

data/README.md

@@ -3,18 +3,20 @@
 [![Code Climate](https://codeclimate.com/github/abookyun/einvoice/badges/gpa.svg)](https://codeclimate.com/github/abookyun/einvoice)
 [![Test Coverage](https://codeclimate.com/github/abookyun/einvoice/badges/coverage.svg)](https://codeclimate.com/github/abookyun/einvoice/coverage)
 
+## What's Einvoice
+
 To support the thriving e-commerce industry and lower the business costs and barriers associated with printing paper receipts, the Taiwan Executive Yuan announced plans in August 2000 to implement electronic receipts in Taiwan and launched a comprehensive project in May 2010 to promote e-invoice applications. This initiative employs innovative approaches such as allowing consumers to claim virtual receipts via multiple devices, offering automatic checking of receipt lottery numbers, and providing a variety of channels for retailers to issue receipts.
 
 Hence, there are several e-invoice services for B2B, B2C in Taiwan as the intermediate and value-adding platform like CHT, allPay, Neweb, ..etc. They mostly provide services like below:
 
 * Manage e-invoices
-* New an e-invoice
+* Issue an e-invoice
 * Return an e-invoice
 * Invalidate an e-invoice
 * List e-invoices
-* ...
+* Others
 
-So that, we need a API wrapper to manage and access the APIs.
+Therefore, we need a API wrapper to manage and access the APIs.
 
 ## Installation
 
@@ -34,7 +36,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Assume one of your customer just make an `@order` including all transaction info for your `@product`. After created the order you're ready to issue this invoice.
+
+### 1. Setup initializer with credentials
+
+```ruby
+Einvoice.configure do |setup|
+  setup.endpoint = ENV['EINVOICE_ENDPOINT']
+  setup.client_id = ENV['EINVOICE_CLIENT_ID']
+  setup.client_secret = ENV['EINVOICE_CLIENT_SECRET']
+  setup.format = "xml"
+end
+```
+
+### 2. Create method for produce payload correspond to issuing action needs
+
+```ruby
+def invoice_payload(order)
+  {
+    data_number: "#{order.data_number}",
+    data_date: "#{order.created_at}",
+    seller_id: "#{order.product.seller_id}",
+    buyer_name: "#{order.buyer_name}",
+    buyer_id: "#{order.buyer_id}",
+    customs_clearance_mark: "#{order.customs_clearance_mark}",
+    invoice_type: "#{order.invoice_type}",
+    donate_mark: "#{order.donate_mark}"
+    carrier_type: "#{order.carrier_type}",
+    carrier_id1: "#{order.carrier_id1}",
+    carrier_id2: "#{order.carrier_id2}",
+    print_mark: "#{order.print_invoice}",
+    n_p_o_b_a_n: "#{order.n_p_o_b_a_n}",
+    random_number: "#{order.random_number}",
+    invoice_item: order.items.each_with_index.map do |item, index|
+      {
+        sequence_number: "#{index}"
+        description: "#{order.product.description}",
+        quantity: "#{item.quantity}",
+        unit_price: "#{item.unit_price}",
+        amount: "#{item.quantity * item.unit_price}",
+      }
+    end,
+    sales_amount: "#{order.sales_amount}",
+    free_tax_sales_amount: "#{order.free_tax_sales_amount}",
+    zero_tax_sales_amount: "#{order.zero_tax_sales_amount}",
+    tax_type: "#{order.tax_type}",
+    tax_rate: "#{order.tax_rate}",
+    tax_amount: "#{order.tax_amount}",
+    total_amount: "#{order.total_amount}",
+    contact: {
+      name: "#{order.user.name}",
+      address: "#{order.user.address}"
+      t_e_l: "#{order.user.mobile}"
+      email: "#{order.user.email}"
+    }
+  }
+end
+```
+
+### 3. Initialize Einvoice::Client with your provider and fire the action
+
+```ruby
+client = Einvoice::Client.new(Einvoice::Neweb::Provider.new)
+client.issue(invoice_payload)
+```
+
+See [More Providers docs]()
+
+### 4. Handle Einvoice::Result object
+
+```ruby
+result = client.issue(invoice_payload)
+# => Einvoice::Result
+
+if result.success?
+  logger.info "Issue invoice for #{order.id} is successful."
+else
+  logger.info "Issue invoice for #{order.id} is failed with #{result.errors}."
+end
+```
+
+See [Einvoice::Result](https://github.com/abookyun/einvoice/blob/master/lib/einvoice/result.rb)
 
 ## Development
 
@@ -44,7 +126,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/einvoice.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abookyun/einvoice.
 
 
 ## License

data/bin/console

@@ -10,5 +10,5 @@ require "einvoice"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/lib/einvoice.rb

@@ -4,7 +4,6 @@ require "einvoice/client"
 require "einvoice/configuration"
 require "einvoice/connection"
 require "einvoice/provider"
-require "einvoice/response"
 require "einvoice/result"
 require "einvoice/utils"
 require "einvoice/version"

data/lib/einvoice/client.rb

@@ -6,8 +6,8 @@ module Einvoice
       @provider = provider
     end
 
-    def issue(payload)
-      provider.issue(payload)
+    def issue(payload, options = {})
+      provider.issue(payload, options)
     end
   end
 end

data/lib/einvoice/configuration.rb

@@ -7,11 +7,13 @@ module Einvoice
       :client_id,
       :client_secret,
       :format,
+      :endpoint_url
     ].freeze
 
     DEFAULT_CLIENT_ID = nil
     DEFAULT_CLIENT_SECRET = nil
     DEFAULT_ENDPOINT = "".freeze
+    DEFAULT_ENDPOINT_URL = nil
     DEFAULT_FORMAT = ""
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -31,9 +33,10 @@ module Einvoice
     end
 
     def reset
-      self.endpoint      = DEFAULT_ENDPOINT
       self.client_id     = DEFAULT_CLIENT_ID
       self.client_secret = DEFAULT_CLIENT_SECRET
+      self.endpoint      = DEFAULT_ENDPOINT
+      self.endpoint_url  = DEFAULT_ENDPOINT_URL
       self.format        = DEFAULT_FORMAT
     end
   end

data/lib/einvoice/connection.rb

@@ -12,7 +12,7 @@ module Einvoice
       }
 
       ::Faraday::Connection.new(options) do |connection|
-        connection.request :digest, client_secret
+        connection.request :digest_neweb, client_secret
         connection.request :url_encoded
 
         # Parser

data/lib/einvoice/neweb/model/base.rb

@@ -1,9 +1,6 @@
 require "active_model"
 
-require "einvoice/neweb/validator/carrier_id1_validator"
-require "einvoice/neweb/validator/carrier_id2_validator"
-require "einvoice/neweb/validator/customs_clearance_mark_validator"
-require "einvoice/neweb/validator/print_mark_validator"
+require "einvoice/neweb/validator/invoice_validator"
 
 module Einvoice
   module Neweb
@@ -14,6 +11,8 @@ module Einvoice
         include ActiveModel::Serialization
         include ActiveModel::Serializers::JSON
 
+        include Einvoice::Neweb::Validator
+
         def attributes=(hash)
           @invoice_item ||= []
           hash.each do |key, value|

data/lib/einvoice/neweb/model/customer_defined.rb

@@ -12,7 +12,7 @@ module Einvoice
 
         validates :project_no, length: { maximum: 64 }
         validates :purchase_no, length: { maximum: 64 }
-        validates :stamp_duty_flag, length: { maximum: 1 }
+        validates :stamp_duty_flag, length: { is: 1 }
       end
     end
   end

data/lib/einvoice/neweb/model/invoice.rb

@@ -2,11 +2,7 @@ module Einvoice
   module Neweb
     module Model
       class Invoice < Base
-        include Einvoice::Validator::Neweb
-
         VALID_OPTIONS_KEYS = [
-          :data_number,
-          :data_date,
           :seller_id,
           :buyer_name,
           :buyer_id,
@@ -33,29 +29,31 @@ module Einvoice
 
         attr_accessor *VALID_OPTIONS_KEYS
 
-        validates :data_number, presence: true, length: { maximum: 20 }
-        validates :data_date, presence: true, length: { maximum: 10 }, format: { with: /\A\d{4}\/\d{2}\/\d{2}\z/ }
         validates :seller_id, presence: true, length: { maximum: 10 }
-        validates :buyer_name, presence: true, length: { maximum: 60 }
+        validates :buyer_name, presence: true, length: { maximum: 60 }, buyer_name: true
         validates :buyer_id, presence: true, length: { maximum: 10 }
-        validates :customs_clearance_mark, length: { maximum: 1 }, format: { with: /[01]/ }, customs_clearance_mark: true, allow_blank: true
-        validates :invoice_type, presence: true, length: { maximum: 2 }, format: { with: /07|08/ }
-        validates :donate_mark, presence: true, length: { maximum: 1 }, format: { with: /[01]/ }
+        validates :customs_clearance_mark, length: { maximum: 1 }, inclusion: { in: %w(1 2) }, allow_blank: true
+        validates :invoice_type, presence: true, length: { is: 2 }, inclusion: { in: %w(07 08) }
+        validates :donate_mark, presence: true, length: { is: 1 }, inclusion: { in: %w(0 1) }, donate_mark: true
         validates :carrier_type, length: { maximum: 6 }, format: { with: /[a-zA-Z]{2}\d{4}/ }, allow_blank: true
         validates :carrier_id1, length: { maximum: 64 }, carrier_id1: true, allow_blank: true
         validates :carrier_id2, length: { maximum: 64 }, carrier_id2: true, allow_blank: true
-        validates :print_mark, presence: true, length: { maximum: 1 }, format: { with: /[YN]/ }, print_mark: true
+        validates :print_mark, presence: true, length: { is: 1 }, inclusion: { in: %w(Y N) }, print_mark: true
         validates :n_p_o_b_a_n, length: { maximum: 10 }
-        validates :random_number, length: { maximum: 4 }
+        validates :random_number, length: { is: 4 }, allow_blank: true
         validates :invoice_item, presence: true
         validates :sales_amount, presence: true, length: { maximum: 12 }, numericality: { greater_than_or_equal_to: 0 }
         validates :free_tax_sales_amount, presence: true, length: { maximum: 12 }, numericality: { greater_than_or_equal_to: 0 }
         validates :zero_tax_sales_amount, presence: true, length: { maximum: 12 }, numericality: { greater_than_or_equal_to: 0 }
-        validates :tax_type, presence: true, length: { maximum: 1 }
+        validates :tax_type, presence: true, length: { is: 1 }, inclusion: { in: %w(1 2 3 4 9) }
         validates :tax_rate, presence: true, length: { maximum: 6 }
         validates :tax_amount, presence: true, length: { maximum: 12 }, numericality: { greater_than_or_equal_to: 0 }
         validates :total_amount, presence: true, length: { maximum: 12 }, numericality: { greater_than_or_equal_to: 0 }
         validates :contact, presence: true
+
+        def initialize
+          raise NotImplementedError, "You should initialize with subclasses"
+        end
       end
     end
   end

data/lib/einvoice/neweb/model/pre_invoice.rb

@@ -0,0 +1,18 @@
+module Einvoice
+  module Neweb
+    module Model
+      class PreInvoice < Invoice
+        TYPE_SPECIFIC_KEYS = [:data_number, :data_date]
+
+        attr_accessor *TYPE_SPECIFIC_KEYS
+
+        validates :data_number, presence: true, length: { maximum: 20 }
+        validates :data_date, presence: true, length: { maximum: 10 }, format: { with: /\A\d{4}\/\d{2}\/\d{2}\z/ }
+
+        def initialize
+          # overwritten
+        end
+      end
+    end
+  end
+end

data/lib/einvoice/neweb/model/seller_invoice.rb

@@ -0,0 +1,18 @@
+module Einvoice
+  module Neweb
+    module Model
+      class SellerInvoice < Invoice
+        TYPE_SPECIFIC_KEYS = [:invoice_number, :invoice_date]
+
+        attr_accessor *TYPE_SPECIFIC_KEYS
+
+        validates :invoice_number, presence: true, length: { maximum: 20 }
+        validates :invoice_date, presence: true, length: { maximum: 10 }, format: { with: /\A\d{4}\/\d{2}\/\d{2}\z/ }
+
+        def initialize
+          # overwritten
+        end
+      end
+    end
+  end
+end

data/lib/einvoice/neweb/provider.rb

@@ -5,29 +5,40 @@ require "einvoice/neweb/model/contact"
 require "einvoice/neweb/model/customer_defined"
 require "einvoice/neweb/model/invoice_item"
 require "einvoice/neweb/model/invoice"
+require "einvoice/neweb/model/pre_invoice"
+require "einvoice/neweb/model/seller_invoice"
+
+require "einvoice/neweb/result"
 
 module Einvoice
   module Neweb
     class Provider < Einvoice::Provider
       include Einvoice::Utils
 
-      def issue(payload)
-        invoice = Einvoice::Neweb::Model::Invoice.new
+      def issue(payload, options)
+        case options[:type]
+        when :seller_invoice
+          action = "IN_SellerInvoiceS.action"
+          invoice = Einvoice::Neweb::Model::SellerInvoice.new
+        else
+          action = "IN_PreInvoiceS.action"
+          invoice = Einvoice::Neweb::Model::PreInvoice.new
+        end
+
         invoice.from_json(payload.to_json)
 
         if invoice.valid?
-          action = "IN_PreInvoiceS.action"
           response = connection.post do |request|
-            request.url endpoint + action
+            request.url endpoint_url || endpoint + action
             request.body = {
               storecode: client_id,
-              xmldata: encode_xml(wrap(serialize(invoice)))
+              xmldata: encode_xml(camelize(wrap(serialize(invoice))))
             }
           end.body
 
-          Einvoice::Result.new(Einvoice::NewebResponse.new(response))
+          Einvoice::Neweb::Result.new(response)
         else
-          Einvoice::Result.new(Einvoice::NewebResponse.new(response))
+          Einvoice::Neweb::Result.new(invoice.errors)
         end
       end
     end

data/lib/einvoice/neweb/result.rb

@@ -0,0 +1,24 @@
+module Einvoice
+  module Neweb
+    class Result < Einvoice::Result
+      def errors
+        if response.is_a? ActiveModel::Errors
+          response.full_messages.join('; ')
+        else
+          data = response && (response.fetch("Result").fetch("Invoice", {}) || response.fetch("Result", {}))
+          data["statcode"] == "0000" ? nil : "#{data["statcode"]}: #{data["statdesc"]}" if data
+        end
+      end
+
+      def success?
+        if response.is_a? ActiveModel::Errors
+          false
+        else
+          response && response.fetch("Result", {}) do |data|
+            data["statcode"] == "0000" ? true : false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/einvoice/neweb/validator/invoice_validator.rb

@@ -0,0 +1,46 @@
+module Einvoice
+  module Neweb
+    module Validator
+      class BuyerNameValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          if record.buyer_id.to_s == "0000000000" &&
+             value.present? && (value.ascii_only? ? value.size > 4 : value.size > 2)
+            record.errors.add attribute, options[:message] || :invalid
+          end
+        end
+      end
+
+      class DonateMarkValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          if value == "1" && record.n_p_o_b_a_n.blank?
+            record.errors.add attribute, options[:message] || :invalid
+          end
+        end
+      end
+
+      class CarrierId1Validator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          if (record.print_mark.to_s == "Y" && value.present?) || (record.print_mark.to_s == "N" && value.blank?)
+            record.errors.add attribute, options[:message] || :invalid
+          end
+        end
+      end
+
+      class CarrierId2Validator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          if (record.print_mark.to_s == "Y" && value.present?) || (record.print_mark.to_s == "N" && value.blank?)
+            record.errors.add attribute, options[:message] || :invalid
+          end
+        end
+      end
+
+      class PrintMarkValidator < ActiveModel::EachValidator
+        def validate_each(record, attribute, value)
+          if value == "Y" && (record.carrier_id1.present? || record.carrier_id2.present? || record.donate_mark == "Y")
+            record.errors.add attribute, options[:message] || :invalid
+          end
+        end
+      end
+    end
+  end
+end

data/lib/einvoice/result.rb

@@ -7,11 +7,11 @@ module Einvoice
     end
 
     def errors
-      response.errors unless success?
+      raise NotImplementedError, 'You must initialize one of Einvoice::Response subclasses then use it.'
     end
 
     def success?
-      response.success?
+      raise NotImplementedError, 'You must initialize one of Einvoice::Response subclasses then use it.'
     end
   end
 end

data/lib/einvoice/version.rb

@@ -1,3 +1,3 @@
 module Einvoice
-  VERSION = "0.2.0"
+  VERSION = "0.2.8"
 end

data/lib/faraday/request/digest_neweb.rb

@@ -19,4 +19,4 @@ module Faraday
   end
 end
 
-Faraday::Request.register_middleware digest: Faraday::Request::DigestNeweb
+Faraday::Request.register_middleware digest_neweb: Faraday::Request::DigestNeweb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: einvoice
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.8
 platform: ruby
 authors:
 - David Yun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -204,13 +204,12 @@ files:
 - lib/einvoice/neweb/model/customer_defined.rb
 - lib/einvoice/neweb/model/invoice.rb
 - lib/einvoice/neweb/model/invoice_item.rb
+- lib/einvoice/neweb/model/pre_invoice.rb
+- lib/einvoice/neweb/model/seller_invoice.rb
 - lib/einvoice/neweb/provider.rb
-- lib/einvoice/neweb/validator/carrier_id1_validator.rb
-- lib/einvoice/neweb/validator/carrier_id2_validator.rb
-- lib/einvoice/neweb/validator/customs_clearance_mark_validator.rb
-- lib/einvoice/neweb/validator/print_mark_validator.rb
+- lib/einvoice/neweb/result.rb
+- lib/einvoice/neweb/validator/invoice_validator.rb
 - lib/einvoice/provider.rb
-- lib/einvoice/response.rb
 - lib/einvoice/result.rb
 - lib/einvoice/utils.rb
 - lib/einvoice/version.rb

data/lib/einvoice/neweb/validator/carrier_id1_validator.rb

@@ -1,13 +0,0 @@
-module Einvoice
-  module Validator
-    module Neweb
-      class CarrierId1Validator < ActiveModel::EachValidator
-        def validate_each(record, attribute, value)
-          if (record.print_mark.to_s == "Y" && value.present?) || (record.print_mark.to_s == "N" && value.blank?)
-            record.errors.add attribute, options[:message] || :invalid
-          end
-        end
-      end
-    end
-  end
-end

data/lib/einvoice/neweb/validator/carrier_id2_validator.rb

@@ -1,13 +0,0 @@
-module Einvoice
-  module Validator
-    module Neweb
-      class CarrierId2Validator < ActiveModel::EachValidator
-        def validate_each(record, attribute, value)
-          if (record.print_mark.to_s == "Y" && value.present?) || (record.print_mark.to_s == "N" && value.blank?)
-            record.errors.add attribute, options[:message] || :invalid
-          end
-        end
-      end
-    end
-  end
-end

data/lib/einvoice/neweb/validator/customs_clearance_mark_validator.rb

@@ -1,13 +0,0 @@
-module Einvoice
-  module Validator
-    module Neweb
-      class CustomsClearanceMarkValidator < ActiveModel::EachValidator
-        def validate_each(record, attribute, value)
-          if record.tax_rate.present? && record.tax_rate.to_i.zero? && value.blank?
-            record.errors.add attribute, options[:message] || :invalid
-          end
-        end
-      end
-    end
-  end
-end

data/lib/einvoice/neweb/validator/print_mark_validator.rb

@@ -1,13 +0,0 @@
-module Einvoice
-  module Validator
-    module Neweb
-      class PrintMarkValidator < ActiveModel::EachValidator
-        def validate_each(record, attribute, value)
-          if value == "Y" && (record.carrier_id1.present? || record.carrier_id2.present? || record.donate_mark == "Y")
-            record.errors.add attribute, options[:message] || :invalid
-          end
-        end
-      end
-    end
-  end
-end

data/lib/einvoice/response.rb

@@ -1,39 +0,0 @@
-module Einvoice
-  class Response
-    attr_reader :response
-
-    def initialize(response = nil)
-      @response = response
-    end
-
-    def errors
-      raise NotImplementedError, 'You must initialize one of Einvoice::Response subclasses then use it.'
-    end
-
-    def success?
-      raise NotImplementedError, 'You must initialize one of Einvoice::Response subclasses then use it.'
-    end
-  end
-
-  class NewebResponse < Response
-    def errors
-      if response.is_a? ActiveModel::Errors
-        response.full_messages.join('; ')
-      else
-        response && response.fetch("Result", {}) do |data|
-          "#{data["statcode"]}: #{data["statdesc"]}"
-        end
-      end
-    end
-
-    def success?
-      if response.is_a? ActiveModel::Errors
-        false
-      elsif response && response.fetch("Result", {})["statdesc"] == "0000"
-        true
-      else
-        false
-      end
-    end
-  end
-end