moloni_api 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc0888f69d92fa88c0a05fa447f841f29289b2e8ab44ed9a22e446d2a1155b2
-  data.tar.gz: 0f40cc723684575b0659735e85a4793d4abe218dd5d246006fc7f09f9d3c0acb
+  metadata.gz: d4ce20574d9044023df19c350c588d21ff192530da34e92b20185c70cf9fffe3
+  data.tar.gz: e40027e3826ea130df3e9f8ab435522958eb549232dc85c87e883c004c7daa93
 SHA512:
-  metadata.gz: ad88efc407714ef37b5a1e7659d0b868565df5d83f58aea2c456c5cbbb1b85c231fba5962acfa77d13915c14195ddad054a4a92a1483f90a32c11943ba0ac25b
-  data.tar.gz: '0739379b6fe2beb1c62c30316d7827f3bc6b6091da77919223f2717fcc6decd64ab83477cfa1c082b6fc438a279996742992a762a0bc6b059f98c71612096d63'
+  metadata.gz: 0c94ad5acf50457127342b81d97f463a4874ea417232ff25dc954b3b69da1fe8338f4a533af16baf422577f7b3949ccf7b84f79fc3da050b2a12084949a79e37
+  data.tar.gz: 0f84659d5f1183ec4b4d75c0c6bf5eaa7ec1ffa2e86dfcaf2ef13c1bd4fc488646b2852df2b80c2764d5a5d4f65a35c2ac358a2222b591723ced38cc204241c3

data/.gitignore

@@ -16,3 +16,5 @@ moloni_api.iml
 
 # custom ignores
 .env
+*.gem
+/.irb_history

data/.irbrc

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'irb'
+require 'irb/completion'
+require 'rubygems'
+require 'pp'
+IRB.conf[:SAVE_HISTORY] = 300

data/Dockerfile

@@ -3,6 +3,7 @@ FROM ruby:3.0
 WORKDIR /usr/src/app
 
 COPY Gemfile .
+COPY Gemfile.lock .
 COPY moloni_api.gemspec .
 COPY lib/moloni_api/version.rb lib/moloni_api/version.rb
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moloni_api (0.1.0)
+    moloni_api (0.1.3)
       faraday (~> 1.3.0)
       oj (~> 3.11)
 
@@ -15,14 +15,14 @@ GEM
       rexml
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faraday (1.3.0)
+    faraday (1.3.1)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
     faraday-net_http (1.0.1)
     hashdiff (1.0.1)
-    multipart-post (2.1.1)
-    oj (3.11.3)
+    multipart-post (2.2.3)
+    oj (3.13.21)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -56,7 +56,7 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
     webmock (3.12.2)

data/README.md

@@ -1,8 +1,16 @@
 # MoloniApi
 
-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/moloni_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+![main workflow](https://github.com/dlage/moloni_api_gem/actions/workflows/main.yml/badge.svg)
+
+Implementation of the [Moloni API](https://www.moloni.pt/dev/endpoints/).
+It's still a rough draft but already usable.
+I will be adding more method implementation but it should be easy for anyone to add new methods (Pull Requests are welcome!).
+There's already a mix of methods implemented to:
+- Get and insert Customers
+- Get Products
+- Get and create some Documents
+- Get Payment Methods
+Moloni's API is quite extensive, reason why I didn't implement methods for all endpoints, yet.
 
 ## Installation
 
@@ -32,7 +40,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]/moloni_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/moloni_api/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/dlage/moloni_api_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dlage/moloni_api_gem/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +48,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MoloniApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/moloni_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MoloniApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dlage/moloni_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -3,10 +3,13 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
 
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+# task default: %i[spec rubocop]
+task default: %i[spec]

data/lib/moloni_api/api.rb

@@ -6,14 +6,14 @@ require_relative 'constants'
 require_relative 'http_status_codes'
 require 'json'
 
+# Core class responsible for api interface operations
 module MoloniApi
-  # Core class responsible for api interface operations
   class API
     include ApiExceptions
     include Constants
     include HttpStatusCodes
 
-    attr_reader(*MoloniApi.configuration.property_names, :token, :endpoint)
+    attr_reader(*MoloniApi.configuration.property_names)
 
     attr_accessor :current_options
 
@@ -27,7 +27,6 @@ module MoloniApi
       end
     end
 
-    API_ENDPOINT = 'https://api.moloni.pt/sandbox/'
     HTTP_STATUS_MAPPING = {
       HTTP_BAD_REQUEST_CODE => BadRequestError,
       HTTP_UNAUTHORIZED_CODE => UnauthorizedError,
@@ -47,10 +46,6 @@ module MoloniApi
       MoloniApi.configuration.property_names.each do |key|
         send("#{key}=", opts[key])
       end
-      @api_access_token = opts[:access_token] # If not provided will need to ask for credentials
-      @api_client_id = opts[:client_id] || ENV['MOLONI_API_CLIENT_ID']
-      @api_client_secret = opts[:client_secret] || ENV['MOLONI_API_CLIENT_SECRET']
-      @api_endpoint = opts[:endpoint] || ENV['MOLONI_API_ENDPOINT'] || API_ENDPOINT
 
       yield_or_eval(&block) if block_given?
     end
@@ -70,11 +65,12 @@ module MoloniApi
       # provide your own logger
       logger = Logger.new $stderr
       logger.level = Logger::DEBUG
-      @client ||= Faraday.new(@api_endpoint) do |client|
+      @client ||= Faraday.new(@endpoint) do |client|
         client.request :url_encoded
-        #client.request :json
-        #client.response :json
+        # client.request :json
+        # client.response :json
         client.adapter Faraday.default_adapter
+        client.headers['User-Agent'] = @user_agent
         client.response :logger, logger
       end
     end
@@ -90,7 +86,7 @@ module MoloniApi
         req.body = params.to_json if params.size
       end
       logger = Logger.new $stderr
-      logger.debug('Response: ' + response.body)
+      logger.debug("Response: #{response.body}")
 
       if response_successful?(response)
         parsed_response = Oj.load(response.body)
@@ -119,7 +115,7 @@ module MoloniApi
       # :nodoc:
       case method_name.to_s
       when /^(.*)\?$/
-        !!send(Regexp.last_match(1).to_s)
+        !send(Regexp.last_match(1).to_s).nil?
       when /^clear_(.*)$/
         send("#{Regexp.last_match(1)}=", nil)
       else

data/lib/moloni_api/client.rb

@@ -3,10 +3,10 @@
 require 'json'
 require 'logger'
 require_relative 'api'
-require_relative 'models/product'
+# require_relative 'models/product'
 
+# Main client class that implements communication with the API
 module MoloniApi
-  # Main client class that implements communication with the API
   # other_params - view documentation for additional options:
   # https://www.moloni.pt/dev/endpoints/
   # - qty
@@ -16,12 +16,11 @@ module MoloniApi
   # - json
   # - human_errors
   class Client < API
-
     attr_accessor :api_access_token, :api_refresh_token
 
     def authenticate(user_username, user_password)
       response = request(
-        http_method: :get,
+        http_method: :post,
         endpoint: 'grant/',
         query_params: {
           grant_type: 'password',
@@ -35,12 +34,12 @@ module MoloniApi
       res = process_response(response)
       self.api_access_token = res[:access_token]
       self.api_refresh_token = res[:refresh_token]
-      return res
+      res
     end
 
     def renew_token(refresh_token = nil)
       response = request(
-        http_method: :get,
+        http_method: :post,
         endpoint: 'grant/',
         query_params: {
           grant_type: 'refresh_token',
@@ -52,12 +51,12 @@ module MoloniApi
       )
       res = process_response(response)
       @api_access_token = res[:access_token]
-      return res
+      res
     end
 
     def companies(other_params: {})
       response = request(
-        http_method: :get,
+        http_method: :post,
         endpoint: 'companies/getAll/',
         query_params: other_params
       )
@@ -73,7 +72,7 @@ module MoloniApi
           company_id: company_id,
           customer_id: customer_id,
           your_reference: your_reference,
-          our_reference: our_reference,
+          our_reference: our_reference
         }.merge(other_params)
       )
       process_response(response)
@@ -87,7 +86,7 @@ module MoloniApi
           company_id: company_id,
           customer_id: customer_id,
           your_reference: your_reference,
-          our_reference: our_reference,
+          our_reference: our_reference
         }.merge(other_params)
       )
       process_response(response)
@@ -101,7 +100,7 @@ module MoloniApi
           company_id: company_id,
           customer_id: customer_id,
           your_reference: your_reference,
-          our_reference: our_reference,
+          our_reference: our_reference
         }.merge(other_params)
       )
       process_response(response)
@@ -131,6 +130,18 @@ module MoloniApi
       process_response(response)
     end
 
+    # economicActivityClassificationCodes/getAll/
+    def economic_activity_classification_codes(company_id, other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'economicActivityClassificationCodes/getAll/',
+        params: {
+          company_id: company_id
+        }
+      )
+      process_response(response)
+    end
+
     # customers/getByNumber/
     def customers_getByNumber(company_id, customer_number)
       response = request(
@@ -138,7 +149,7 @@ module MoloniApi
         endpoint: 'customers/getByNumber/',
         params: {
           company_id: company_id,
-          number: customer_number,
+          number: customer_number
         }
       )
       process_response(response)
@@ -224,7 +235,7 @@ module MoloniApi
         endpoint: 'products/getBySearch/',
         params: {
           company_id: company_id,
-          search: search_str,
+          search: search_str
         }.merge(other_params)
       )
       process_response(response)
@@ -236,12 +247,61 @@ module MoloniApi
         endpoint: 'products/getByReference/',
         params: {
           company_id: company_id,
-          reference: reference,
+          reference: reference
         }.merge(other_params)
       )
       process_response(response)
     end
 
+    #############################################
+    ### Global Data Methods
+    # Note: Calls to these methods should be cached somewhere
+    #############################################
+    def countries(other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'countries/getAll/',
+        query_params: other_params
+      )
+      process_response(response)
+    end
+
+    def languages(other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'languages/getAll/',
+        query_params: other_params
+      )
+      process_response(response)
+    end
+
+    def fiscal_zones(other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'fiscalZones/getAll/',
+        query_params: other_params
+      )
+      process_response(response)
+    end
+
+    def currencies(other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'currencies/getAll/',
+        query_params: other_params
+      )
+      process_response(response)
+    end
+
+    def document_models(other_params: {})
+      response = request(
+        http_method: :post,
+        endpoint: 'documentModels/getAll/',
+        query_params: other_params
+      )
+      process_response(response)
+    end
+
     protected
 
     def process_response(response)
@@ -249,7 +309,7 @@ module MoloniApi
       case result
       when Hash
         result.transform_keys!(&:to_sym)
-        result.values.each do |r|
+        result.each_value do |r|
           process_response(r)
         end
       when Array

data/lib/moloni_api/configuration.rb

@@ -6,23 +6,31 @@ require_relative 'version'
 module MoloniApi
   # Stores the configuration
   class Configuration < API::Config
+    API_ENDPOINT = 'https://api.moloni.pt/sandbox/'
+    API_CLIENT_ID = 'apigem'
+    API_CLIENT_SECRET = 'c9c9f4274658da2ad78b55a452894942898b5614'
+
     property :follow_redirects, default: true
 
     # The api endpoint used to connect to MoloniApi if none is set
     # prd: https://api.moloni.pt/v1/
     # sandbox: https://api.moloni.pt/sandbox/
-    property  :endpoint, default: 'https://api.moloni.pt/sandbox/'
+    property :endpoint, default: ENV['MOLONI_API_ENDPOINT'] || API_ENDPOINT
 
     # The value sent in the http header for 'User-Agent' if none is set
-    property  :user_agent, default: "MoloniApi API Ruby Gem #{MoloniApi::VERSION}"
+    property :user_agent, default: "MoloniApi API Ruby Gem #{MoloniApi::VERSION}"
 
     # By default uses the Faraday connection options if none is set
-    property  :connection_options, default: {}
+    property :connection_options, default: {}
 
     # By default display 30 resources
     property :per_page, default: 20
 
     # Add Faraday::RackBuilder to overwrite middleware
     property :stack
+
+    property :api_access_token
+    property :api_client_id, default: ENV['MOLONI_API_CLIENT_ID'] || API_CLIENT_ID
+    property :api_client_secret, default: ENV['MOLONI_API_CLIENT_SECRET'] || API_CLIENT_SECRET
   end
 end

data/lib/moloni_api/models/product.rb

@@ -1,39 +1,42 @@
+# frozen_string_literal: true
+
 module MoloniApi
   module Models
+    # Model to map product
     class Product
       ##
       # company_id int
-      # Obrigatório
+      # Mandatory
       #
       # category_id int
-      # Obrigatório
+      # Mandatory
       #
       # type int
-      # Obrigatório
+      # Mandatory
       #
       # name string
-      # Obrigatório
+      # Mandatory
       #
       # summary string
       # Facultativo
       #
       # reference string
-      # Obrigatório
+      # Mandatory
       #
       # ean string
       # Facultativo
       #
       # price float
-      # Obrigatório
+      # Mandatory
       #
       # unit_id int
-      # Obrigatório
+      # Mandatory
       #
       # has_stock int
-      # Obrigatório
+      # Mandatory
       #
       # stock float
-      # Obrigatório
+      # Mandatory
       #
       # minimum_stock float
       # Facultativo
@@ -51,25 +54,25 @@ module MoloniApi
       # Facultativo
       #
       # tax_id int
-      # Obrigatório
+      # Mandatory
       #
       # value float
-      # Obrigatório
+      # Mandatory
       #
       # order int
-      # Obrigatório
+      # Mandatory
       #
       # cumulative int
-      # Obrigatório
+      # Mandatory
       #
       # suppliers array
       # Facultativo
       #
       # supplier_id int
-      # Obrigatório
+      # Mandatory
       #
       # cost_price float
-      # Obrigatório
+      # Mandatory
       #
       # referenceint
       # Facultativo
@@ -78,19 +81,19 @@ module MoloniApi
       # Facultativo
       #
       # property_id int
-      # Obrigatório
+      # Mandatory
       #
       # value string
-      # Obrigatório
+      # Mandatory
       #
       # warehouses array
       # Facultativo
       #
       # warehouse_id int
-      # Obrigatório
+      # Mandatory
       #
       # stock float
-      # Obrigatório
+      # Mandatory
       def initialize(raw_result)
         @raw_result = raw_result
 

data/lib/moloni_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MoloniApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.4'
 end

data/moloni_api.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dinis']
   spec.email         = ['dinis@lage.pw']
 
-  spec.summary       = 'FantasticStay API Wrapper.'
-  spec.description   = 'A gem that implements functions from the FS API available for its users.'
+  spec.summary       = 'Moloni API Wrapper.'
+  spec.description   = 'A gem that implements functions from the Moloni API available for its users.'
   spec.homepage      = 'https://github.com/dlage/moloni_api_gem'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/dlage/moloni_api_gem'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moloni_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Dinis
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-description: A gem that implements functions from the FS API available for its users.
+description: A gem that implements functions from the Moloni API available for its
+  users.
 email:
 - dinis@lage.pw
 executables: []
@@ -47,6 +48,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -81,7 +83,7 @@ metadata:
   homepage_uri: https://github.com/dlage/moloni_api_gem
   source_code_uri: https://github.com/dlage/moloni_api_gem
   changelog_uri: https://github.com/dlage/moloni_api_gem/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
-summary: FantasticStay API Wrapper.
+summary: Moloni API Wrapper.
 test_files: []