moloni_api 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e69b155c0a94bb39b79a4e142a5deaf641345aab30e7f0e19ad92a5e064f15bb
-  data.tar.gz: d3f7a249753d6f3d8ef80ca7b6360728727e40a3699310db333c4488781e123f
+  metadata.gz: 74d28c5f93cc5740ba6cf9f0af4937b931701c0b8914f795a5f888275b119bf3
+  data.tar.gz: 87d99c68508f7cb982f97e8b561f53620ae993509fd95ab3ed7ade1c31b0e8f8
 SHA512:
-  metadata.gz: c54055bb484de6fd2bd56143a742a7419b7050b49a8cf4ffb21b3b3b88450551c975f5d49d1f49728d234b636bd9dc4344a9ee326b5a45aef65545256d36b5e3
-  data.tar.gz: ef1d0def451c722d60385cf6ac38333505a353f352ac156bb7fa72b72249ab74facd0d50cb22703e3813d9f69a66552bff19dcd053e0a50a54828f3b46e7e7b1
+  metadata.gz: d59fa669a82f34f31b520a340aaa245d2236d1b253e73d70f7c00cf9470cbb02fc938e227e1df92115196136b762e4cd2bf7705460f49a1075a005baac073de1
+  data.tar.gz: 28e247ea912108102b9725adba774564b5354c0840f5933573f903139a305d07b2e12ce010061465e39f94908ae36c5ac14dd301d26de679002d0938d07aebf4

data/.gitignore

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

data/.irbrc

@@ -0,0 +1,5 @@
+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.2)
       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,14 @@
 # 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
+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 +38,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. 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/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +46,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/lib/moloni_api/api.rb

@@ -13,7 +13,7 @@ module MoloniApi
     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

data/lib/moloni_api/client.rb

@@ -21,7 +21,7 @@ module MoloniApi
 
     def authenticate(user_username, user_password)
       response = request(
-        http_method: :get,
+        http_method: :post,
         endpoint: 'grant/',
         query_params: {
           grant_type: 'password',
@@ -40,7 +40,7 @@ module MoloniApi
 
     def renew_token(refresh_token = nil)
       response = request(
-        http_method: :get,
+        http_method: :post,
         endpoint: 'grant/',
         query_params: {
           grant_type: 'refresh_token',
@@ -131,6 +131,19 @@ module MoloniApi
       process_response(response)
     end
 
+    # customers/getByNumber/
+    def customers_getByNumber(company_id, customer_number)
+      response = request(
+        http_method: :post,
+        endpoint: 'customers/getByNumber/',
+        params: {
+          company_id: company_id,
+          number: customer_number,
+        }
+      )
+      process_response(response)
+    end
+
     # customers/getAll/
     def customers_getAll(company_id)
       response = request(
@@ -229,6 +242,55 @@ module MoloniApi
       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)

data/lib/moloni_api/configuration.rb

@@ -6,23 +6,29 @@ require_relative 'version'
 module MoloniApi
   # Stores the configuration
   class Configuration < API::Config
+    API_ENDPOINT = 'https://api.moloni.pt/sandbox/'
+
     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']
+    property :api_client_secret, default: ENV['MOLONI_API_CLIENT_SECRET']
   end
 end

data/lib/moloni_api/version.rb

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

data/moloni_api.gemspec

@@ -8,8 +8,8 @@ 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')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moloni_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Dinis
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-10-21 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: []