lmb-developers 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca4a980414d934e35a3abb1eda08230e0aaf3686c4e15da8a937f813c4ff2e2a
+  data.tar.gz: 73dae7b30f033de9c07dfac6c3b4ed75063fca95ac1a4eb352ec1a2453c0c8c0
+SHA512:
+  metadata.gz: 3daaa7854edbd80ff5facac95814888f7ef91d5574bf339371cada016b224fcf23512800a750db8a5bc77028fc7bd3492ecae37985aa83e2515ff49b1e0244bc
+  data.tar.gz: 705cca1029bba160ccb4db98a5b64ba9cb227599d3d56657af919bfb0bf2428e0d1516527cfb941235f4ef0ab5ef50a1f6d921fa5299658427979ede9adc6eae

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.gem
+doc/
+.yardoc/

data/README.md

@@ -0,0 +1,60 @@
+[![Gem Version](https://badge.fury.io/rb/lmb-developers.svg)](http://badge.fury.io/rb/lmb-developers)
+
+# Lmb Developers
+
+A ruby wrapper for the Leroy Merlin Brazil Developers API available at [Leroy Merlin Brazil Developer's Portal](https://developers.leroymerlin.com.br)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lmb-developers'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lmb-developers
+
+## Usage
+
+### Configuration
+
+```ruby
+
+# Pass environment and api_key to configure
+Lmb::Developers.configure('environment', 'api_key')
+
+```
+
+The environment can be 'TEST' or 'PROD'.
+
+You will need an api_key that can be obtained at [Leroy Merlin Brazil Developer's Portal](https://developers.leroymerlin.com.br)
+
+### Methods
+
+Ldap Login
+
+```ruby
+Lmb::Developers::Auth.login("ldap_username", "ldap_password", "ldap_usertype = employee")
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lmb-developers/fork )
+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 a new Pull Request
+
+We are always keen to learn so please feel free to create an issue with code reviews, suggestions and possible refactorings.
+
+## TODOS
+
+- Docs
+- Tests
+- Other Methods

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/lmb/developers/auth.rb

@@ -0,0 +1,71 @@
+module Lmb
+    module Developers
+        class Auth
+            attr_reader :configuration
+            
+            # Path to consume login
+            AUTH_PATH = '/v1/auth/login'
+
+            # Check if user is valid in LMB Ldap.
+            #
+            # @param username [String] the ldap username.
+            # @param password [String] the ldap password.
+            # @param user_type [String] the ldap user_type, `employee` (default), `customer` or `supplier`
+            # @return [Hash] when login successful.
+            #  * [String] :userType LDAP user_type
+            #  * [String] :username LDAP of the employee
+            #  * [String] :employeeID ID of the employee
+            #  * [String] :employeeType EmployeeType
+            #  * [String] :fullName Full Name of the user 
+            #  * [String] :givenName Given Name of the user
+            #  * [String] :surname Surname of the user
+            #  * [String] :title Mission designated to the user
+            #  * [String] :titleCode Code of mission designated to the user
+            #  * [String] :locationName Site where the user works
+            #  * [String] :locationCode Code from site where the user works
+            #  * [String] :department Department of the user
+            #  * [Date] :contractStartDate Contract start date of the user
+            #  * [String] :email Email of the user
+            #  * [String] :Telephone number of the user's department
+            #  * [String] :mobile Mobile phone number of the user
+            #  * [String] :manager Manager's distinguish name from LDAP
+            #  * [String] :o Brands abbreviation. E.g. LM for Leroy Merlin
+            #  * [String] :ou Organization unit
+            #  * [Date] :birthdate Birthdate from user
+            #  * [String] :createdBy Distinguish name from user that created the registry in LDAP
+            #  * [String] :modifiedBy Distinguish name from user that modified the registry in LDAP
+            #  * [Byte] :jpegPhoto Binary Base64 represeting JPEG photo.   
+            # @return [Lmb::Developers::Error] when login failure.
+            def self.login username, password, user_type = 'employee'
+                begin
+                    uri = URI.parse("#{configuration.url}#{AUTH_PATH}")
+                    request = Net::HTTP::Post.new(uri)
+                    request.content_type = "application/x-www-form-urlencoded"
+                    request["Apikey"] = "#{configuration.api_key}"
+                    request["Cache-Control"] = "no-cache"
+                    request.body = "username=#{username}&password=#{password}&userType=#{user_type}"
+                    req_options = {
+                        use_ssl: uri.scheme == "https",
+                    }
+                    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                        http.request(request)
+                    end
+                    result = JSON.parse(response.body)
+                    if response.code.to_i == 200
+                        result
+                    else
+                        fail Error, JSON.parse(response.body)
+                    end
+                rescue => exception
+                    exception
+                end
+
+            end
+            
+            # Get configuration.
+            def self.configuration
+                @configuration = Lmb::Developers.configuration
+            end
+        end
+    end
+end

data/lib/lmb/developers/configuration.rb

@@ -0,0 +1,33 @@
+module Lmb
+    module Developers
+      class Configuration
+        attr_accessor :api_key,
+                      :environment
+        attr_reader :url
+        
+        # Initial config.
+        def initialize
+            @config = {
+                'TEST' => {
+                    'url': 'https://api-test.leroymerlin.com.br'
+                },
+                'PROD' => {
+                    'url' => 'https://api.leroymerlin.com.br',
+                }
+            }
+            configure('TEST', nil)
+        end
+        # Configure global parameters
+        #
+        # @param environment [String] environment to consume APIs, `TEST` or `PROD`
+        # @param api_key [String] ApiKey to consume APIs.
+        # @return [Lmb::Developers::Configuration]
+        def configure(environment = 'TEST', api_key)
+            @api_key = api_key
+            @environment = environment
+            @url = @config[environment][:url]
+            self
+        end
+      end
+    end
+end

data/lib/lmb/developers/error.rb

@@ -0,0 +1,5 @@
+module Lmb
+    module Developers
+      class Error < StandardError; end
+    end
+end

data/lib/lmb/developers.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+require 'json'
+require 'lmb/developers/configuration'
+require 'lmb/developers/auth'
+require 'lmb/developers/error'
+module Lmb
+    module Developers
+        class << self
+            attr_reader :configuration
+            
+            # Configure global parameters
+            #
+            # @param environment [String] environment to consume APIs, `TEST` or `PROD`
+            # @param api_key [String] ApiKey to consume APIs.
+            # @return [Lmb::Developers::Configuration]
+            def configure(environment, api_key)
+                configuration.configure(environment, api_key)
+            end
+            
+            # Instace or return global configuration
+            def configuration
+                @configuration ||= Configuration.new
+            end
+        end
+    end
+end

data/lib/lmb.rb

@@ -0,0 +1 @@
+require 'lmb/developers'

data/lmb-developers.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+    s.name        = 'lmb-developers'
+    s.version     = '1.1.2'
+    s.date        = '2019-01-10'
+    s.summary     = "Consume APIs at Leroy Merlin Brazil Developer's Portal"
+    s.description = "Gem to consume APIs available at Leroy Merlin Brazil Developer's Portal https://developers.leroymerlin.com.br"
+    s.author      = "PRTE - Tecnologia e Soluções"
+    s.email       = 'contato@prte.com.br'
+    s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    s.require_paths = ['lib']
+    s.homepage    =
+      'https://github.com/somosprte/lmb-developers'
+    s.license       = 'MIT'
+  end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: lmb-developers
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- PRTE - Tecnologia e Soluções
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-10 00:00:00.000000000 Z
+dependencies: []
+description: Gem to consume APIs available at Leroy Merlin Brazil Developer's Portal
+  https://developers.leroymerlin.com.br
+email: contato@prte.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- lib/lmb.rb
+- lib/lmb/developers.rb
+- lib/lmb/developers/auth.rb
+- lib/lmb/developers/configuration.rb
+- lib/lmb/developers/error.rb
+- lmb-developers.gemspec
+homepage: https://github.com/somosprte/lmb-developers
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Consume APIs at Leroy Merlin Brazil Developer's Portal
+test_files: []