my_data 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb6195b397b23da4c0756c94382ac9a245ea48ff07c7bcff7ce75d318750f55
-  data.tar.gz: 2443d4836cecf9d08657e998a39ca73cdcdc58d131463b805be2c84a4429ed53
+  metadata.gz: 21734192525f3cdc66a24be64cfc3f147647f8decb6f71a6cd17094f5fc79bcb
+  data.tar.gz: ce56b3d0ec170898a593cbfab881e843c1a89a3e3de6a055dce39f0d302f6a67
 SHA512:
-  metadata.gz: e3922efa99513f4222db05df50762d502252a99c0159ec11ae0ea35c2ceb5bd89612a54dac86d22e5ccaeca33f573aa58b7f011a00f7da09e65482bdd7e6693d
-  data.tar.gz: 0135fb723a5e2f759bd5cab73c91c31ef1ef3a47303e111a02593d9589403dc07756e9353e3f3de11becbe84c08ccad4031e06ed61fd9a03ded8c666c2b994aa
+  metadata.gz: e18093c80a0108ee8fe815ab50ca359cc019e2346a297b62e45d7c27f83652cab79461c5549bf6e69cad6752a546ae536bf84a10ecf23e320b2bdbb426cb932b
+  data.tar.gz: 9d64a6162fbb18bb511159e8c43d2117c795e91e222ce7e5ca10523b6cc7aea72b6bf9412245185537dadd7a512ade270f46672278b982f8377e86a68d5e3ca1

data/.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: Lint
+
+on: push
+
+jobs:
+  run-test-lint:
+    name: Run tests and linter
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+        gemfile: ['Gemfile']
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      
+      - name: Run Rubocop
+        uses: wearerequired/lint-action@v1
+        with:
+          rubocop: true
+          rubocop_command_prefix: bundle exec
+
+      - name: Run specs
+        run: bundle exec rake spec
+

data/.rubocop.yml

@@ -1,11 +1,17 @@
+require: 
+ - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
 Metrics/ModuleLength:
   Max: 200
 
 Metrics/MethodLength:
-    Max: 15
+  Max: 15
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  IgnoredMethods:
     - class_methods
 
 Style/Documentation:
@@ -30,3 +36,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Lint/UselessAccessModifier:
+  ContextCreatingMethods:
+    - class_methods

data/Gemfile

@@ -7,9 +7,14 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "rspec", "~> 3.0"
-
-group :development do
+group :development, :test do
+  gem "factory_bot"
+  gem "guard-rspec", require: false
   gem "pry"
-  gem "rubocop", "~> 0.80"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-rake", "~> 0.5"
+  gem "rubocop-rspec", "~> 2.0"
+  gem "vcr"
+  gem "webmock"
 end

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/README.md

@@ -1,8 +1,6 @@
-# MyData
+# AADE MyData ruby client
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/my_data`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby client for [AADE myDATA](https://www.aade.gr/mydata) API
 
 ## Installation
 
@@ -20,15 +18,64 @@ Or install it yourself as:
 
     $ gem install my_data
 
+## Resources
+There are all the [resources](https://github.com/mikezaby/my_data/tree/master/lib/my_data/resources)
+that are specified by the given
+[xsd files](https://www.aade.gr/sites/default/files/2020-11/version%20v1.0.2%20XSDs.zip) from AADE.
+
+e.x.
+```irb
+irb> MyData::Resources::Inv::PartyType
+=> MyData::Resources::Inv::PartyType vat_number: string, country: string, branch: integer, name: string, address: MyData::Resources::Inv::AddressType
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+##### Initialize client
+```ruby
+client = MyData::Client.new(user_id: "johndoe", subscription_key: "c9b79ff1841fb5cfecc66e1ea5a29b4d")
+```
 
-## Development
+##### Send invoices
+```ruby
+# send invoices
+invoice_data = {
+  issuer: { vat_number: "111111111", country: "GR", branch: 0 },
+  invoice_header: { series: "A", aa: "1", issue_date: "2021-02-21", invoice_type: "11.2", currency: "EUR" },
+  invoice_details: [{
+    line_number: "1",
+    net_value: 100.00,
+    vat_category: 1,
+    vat_amount: 24.00,
+    income_classification: [{ classification_type: "E3_561_003", classification_category: "category1_3", amount: 100.00 }]
+  }],
+  invoice_summary: {
+    total_net_value: 100.00,
+    total_vat_amount: 24.00,
+    total_withheld_amount: 0.0,
+    total_fees_amount: 0.0,
+    total_stamp_duty_amount: 0.0,
+    total_other_taxes_amount: 0.0,
+    total_deductions_amount: 0.0,
+    total_gross_value: 124.00,
+    income_classification: [{ classification_type: "E3_561_003", classification_category: "category1_3", amount: 100.00 }]
+  },
+  payment_methods: [{ type: 3, amount: 124.00 }]
+}
+
+invoices_doc = MyData::Resources::Inv::InvoicesDoc.new(invoice: [invoice_data])
+client.send_invoices(doc: invoices_doc.to_xml)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+##### Request transmitted docs
+```ruby
+client.request_transmitted_docs(mark: 1)
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+##### Cancel Invoice
+  ```ruby
+client.cancel_invoice(mark: 400001831924171)
+  ```
 
 ## Contributing
 

data/lib/my_data.rb

@@ -4,21 +4,20 @@ require "active_model"
 require "active_support/all"
 require "faraday"
 require "nokogiri"
-
-require_relative "my_data/version"
+require "zeitwerk"
 
 module MyData
+  LOADER = Zeitwerk::Loader.for_gem
+  LOADER.enable_reloading
+  LOADER.setup
+
   class Error < StandardError; end
 
   def self.root
-    File.expand_path '../..', __FILE__
+    File.expand_path "..", __dir__
   end
 
-  autoload :Client, "my_data/client"
-  autoload :Resource, "my_data/resource"
-  autoload :Resources, "my_data/resources"
-  autoload :TypeCaster, "my_data/type_caster"
-  autoload :XmlGenerator, "my_data/xml_generator"
-  autoload :XmlParser, "my_data/xml_parser"
-  autoload :Xsd, "my_data/xsd"
+  def self.reload!
+    MyData::LOADER.reload
+  end
 end

data/lib/my_data/client.rb

@@ -9,25 +9,48 @@ module MyData
       @subscription_key = subscription_key
     end
 
-    def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
-        conn.headers = headers
-      end
+    def send_invoices(doc:)
+      response = connection.post("SendInvoices", doc)
+
+      parse_response(
+        response,
+        resource: MyData::Resources::Response,
+        root: "response_doc"
+      )
+    end
+
+    def request_transmitted_docs(mark:)
+      response = connection.get("RequestTransmittedDocs", mark: mark)
+
+      parse_response(
+        response,
+        resource: MyData::Resources::Inv::RequestDoc,
+        root: "requested_doc"
+      )
     end
 
-    def send_invoice(invoice_doc)
-      response = connection.post("SendInvoices", invoice_doc)
+    def cancel_invoice(mark:)
+      response = connection.post("CancelInvoice") do |req|
+        req.params["mark"] = mark
+      end
 
-      response_parser(response.body)
+      parse_response(
+        response,
+        resource: MyData::Resources::Response,
+        root: "response_doc"
+      )
     end
 
     private
 
-    def response_parser(response)
-      fixed_xml = response.sub(/^.+/, "").sub("</string>", "").strip
-                          .gsub("&lt;", "<").gsub("&gt;", ">")
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers = headers
+      end
+    end
 
-      Hash.from_xml(fixed_xml)
+    def parse_response(response, resource:, root:)
+      MyData::ResponseParser.new(response, resource: resource, root: root)
     end
 
     def headers

data/lib/my_data/resource.rb

@@ -29,15 +29,15 @@ module MyData
         @container[:attributes] = opts
       end
 
-      def xsd_structure
-        MyData::Xsd::Structure.resource_attributes(name).each do |attrs|
-          e_name, type, opts = attrs
-          required = opts.delete :required
+      def xsd_doc
+        doc_name, doc = MyData::Xsd::Structure.doc(name)
+        container_tag(doc_name, doc.attributes)
 
-          attribute(e_name, type, opts)
+        xsd_resource_attributes(name, :doc)
+      end
 
-          validates_presence_of e_name if required
-        end
+      def xsd_complex_type
+        xsd_resource_attributes(name, :complex_type)
       end
 
       # @param name [String] the name of the attribute
@@ -59,9 +59,8 @@ module MyData
         @attributes.push(name)
         attr_mappings(name, type, opts)
 
-        attr_reader name
-
-        define_attr_setter name, collection: !!opts[:collection]
+        define_attr_getter name, collection: opts[:collection]
+        define_attr_setter name, collection: opts[:collection]
       end
 
       def inspect
@@ -76,13 +75,19 @@ module MyData
         "#{name} #{format_attrs.join(", ")}"
       end
 
-      def from_xml(doc_or_string)
-        doc = doc_or_string.is_a?(String) ? Nokogiri::XML(doc_or_string).child : doc_or_string
-        new(parse_xml(doc))
-      end
-
       private
 
+      def xsd_resource_attributes(name, type)
+        MyData::Xsd::Structure.resource_attributes(name, type).each do |attrs|
+          e_name, type, opts = attrs
+          required = opts.delete :required
+
+          attribute(e_name, type, opts)
+
+          validates_presence_of e_name if required
+        end
+      end
+
       def attr_mappings(name, type, opts)
         resource =
           if type == :resource
@@ -98,6 +103,14 @@ module MyData
         }
       end
 
+      def define_attr_getter(name, collection: false)
+        define_method name do
+          value = instance_variable_get("@#{name}")
+
+          collection && value.nil? ? [] : value
+        end
+      end
+
       def define_attr_setter(name, collection: false)
         define_method "#{name}=" do |value|
           type, resource = self.class.mappings[name].values_at(:type, :resource)
@@ -112,11 +125,6 @@ module MyData
           instance_variable_set("@#{name}", type_casted_value)
         end
       end
-
-      def parse_xml(doc)
-        parser = MyData::XmlParser.new(doc, mappings, name)
-        parser.parse_xml
-      end
     end
 
     def initialize(attrs = {})
@@ -134,6 +142,8 @@ module MyData
     end
 
     def attributes=(attrs)
+      attrs = attrs.respond_to?(:attributes) ? attrs.attributes : attrs
+
       attrs.each do |key, value|
         next unless attribute_names.include?(key.to_s)
 
@@ -152,15 +162,7 @@ module MyData
 
       return true if is_valid
 
-      resources.compact.each do |k, resource|
-        rs = resource.is_a?(Array) ? resource : [resource]
-
-        next if rs.all?(&:valid?)
-
-        rs.each do |r|
-          errors.add(k, :invalid_resource, message: r.errors.full_messages.join(", "))
-        end
-      end
+      add_nested_errors
 
       false
     end
@@ -187,5 +189,17 @@ module MyData
       generator = MyData::XmlGenerator.new(self)
       generator.to_xml
     end
+
+    private
+
+    def add_nested_errors
+      resources.compact.each do |k, resource|
+        rs = resource.is_a?(Array) ? resource : [resource]
+
+        rs.reject(&:valid?).each do |r|
+          errors.add(k, :invalid_resource, message: r.errors.full_messages.join(", "))
+        end
+      end
+    end
   end
 end

data/lib/my_data/resources/continuation_token_type.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class MyData::Resources::ContinuationTokenType
+  include MyData::Resource
+
+  xsd_complex_type
+end

data/lib/my_data/resources/ecls/expenses_classification.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class MyData::Resources::Ecls::ExpensesClassification
+  include MyData::Resource
+
+  xsd_doc
+end

data/lib/my_data/resources/ecls/expenses_classification_type.rb

@@ -3,5 +3,5 @@
 class MyData::Resources::Ecls::ExpensesClassificationType
   include MyData::Resource
 
-  xsd_structure
+  xsd_complex_type
 end

data/lib/my_data/resources/ecls/invoice_expenses_classification_type.rb

@@ -3,5 +3,5 @@
 class MyData::Resources::Ecls::InvoiceExpensesClassificationType
   include MyData::Resource
 
-  xsd_structure
+  xsd_complex_type
 end

data/lib/my_data/resources/ecls/invoices_expenses_classification_detail_type.rb

@@ -3,5 +3,5 @@
 class MyData::Resources::Ecls::InvoicesExpensesClassificationDetailType
   include MyData::Resource
 
-  xsd_structure
+  xsd_complex_type
 end