orias 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 063aaf0efbd771a7a33f9446d4ae3c362a568460
-  data.tar.gz: 4cacdf0afca699c83942b5e08b307e945eeb231d
+  metadata.gz: af2eff4a09534ebe0f400f5dbece87f1ee526750
+  data.tar.gz: 1f3a5c974e5e3943d633cfd2ee678e79be8ada9b
 SHA512:
-  metadata.gz: 37c47e18ea995947e2a8d8ca7927efa500144737fef2aa1a9693623ab216ed0a0ce944e8406798848d8a8f40efdb63a7e8c026f287d0db4214e670fd085d4aa8
-  data.tar.gz: c9c19af1c4ca0bb1a4ae1ea0ca03cbb7e1c941cd8b744e5a0a9e856d900b4d1f1e1e7551bb82be484af61585ef54c37fe78c3a44b0470e84dc86b0d12dd7623e
+  metadata.gz: a3ed5329adbedbbdfe24d9568c54c074841548e95ce7951fa70a6be4d60a5766add809a2ae63e4f9f4fb3248eda907c3b216f95d5c149c0b3a7437cd51df3b18
+  data.tar.gz: a2ccc2dc4054440621714f553244fb94fc3155af8e028cb39bfc86547455bade0b2ba79ef9f60f70a7b18f7d90700e1ffd3be72c97f264873e1bbf403c062879

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/Gemfile.lock

@@ -2,17 +2,26 @@ PATH
   remote: .
   specs:
     orias (0.1.0)
+      libxml-to-hash
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
     ast (2.4.0)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     docile (1.3.1)
+    faker (1.9.1)
+      i18n (>= 0.7)
     hirb (0.7.3)
+    i18n (1.5.1)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     json (2.1.0)
+    libxml-ruby (3.1.0)
+    libxml-to-hash (0.2.1)
+      libxml-ruby
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
@@ -57,6 +66,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  faker (~> 1.9)
   orias!
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,6 +1,7 @@
 # Orias
 
 
+[![Gem Version](https://badge.fury.io/rb/orias.svg)](https://badge.fury.io/rb/orias)
 [![Build Status](https://travis-ci.org/01max/orias.svg?branch=master)](https://travis-ci.org/01max/orias)
 [![Maintainability](https://api.codeclimate.com/v1/badges/634c92245aefc4bba229/maintainability)](https://codeclimate.com/github/01max/orias/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/634c92245aefc4bba229/test_coverage)](https://codeclimate.com/github/01max/orias/test_coverage)

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task :default => :spec
+task default: %i[spec rubocop]

data/bin/console

@@ -1,14 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "orias"
+require 'bundler/setup'
+require 'orias'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/orias/base.rb

@@ -0,0 +1,24 @@
+module Orias
+  # Base Orias class
+  #
+  class Base
+    def initialize(attributes = {})
+      _assign_attributes(attributes)
+    end
+
+    private
+
+    def _assign_attributes(attributes)
+      attributes.each do |key, value|
+        _assign_attribute(key, value)
+      end
+    end
+
+    def _assign_attribute(key, value)
+      setter = :"#{key}="
+      raise UnknownAttributeError.new(self, key) unless respond_to?(setter)
+
+      public_send(setter, value)
+    end
+  end
+end

data/lib/orias/client.rb

@@ -0,0 +1,14 @@
+module Orias
+  # Dedicated to request handling to ORIAS API
+  #
+  class Client < Base
+    attr_accessor :api_endpoint, :private_key
+
+    # Initialize an Orias::Client instance
+    def initialize(attributes = {})
+      super
+      @api_endpoint ||= Orias.configuration.api_endpoint
+      @private_key ||= Orias.configuration.private_key
+    end
+  end
+end

data/lib/orias/configuration.rb

@@ -0,0 +1,15 @@
+module Orias
+  # Dedicated to configuration management
+  #
+  class Configuration < Base
+    DEFAULT_API_ENDPOINT = 'https://ws.orias.fr/service?wsdl'.freeze
+
+    attr_accessor :private_key, :api_endpoint
+
+    # Initialize an Orias::Configuration instance
+    def initialize(attributes = {})
+      super
+      @api_endpoint ||= DEFAULT_API_ENDPOINT
+    end
+  end
+end

data/lib/orias/intermediary.rb

@@ -0,0 +1,47 @@
+module Orias
+  # Dedicated to Orias intermediaries objects handling
+  #
+  class Intermediary < Base
+    attr_accessor :raw, :found, :siren, :orias, :denomination, :registrations
+
+    alias_method :registration_number, :orias
+
+    # Initialize an Orias::Intermediary instance
+    def initialize(attributes = {})
+      @raw = attributes
+
+      base = @raw.dig('informationBase')
+
+      @found = base.dig('foundInRegistry') == 'true'
+      @siren = base.dig('siren')
+      @orias = base.dig('registrationNumber')
+      @denomination = base.dig('denomination')
+
+      raw_registrations = @raw.dig('registrations', 'registration')
+      unless raw_registrations.is_a?(Array)
+        raw_registrations = [raw_registrations]
+      end
+
+      @registrations = raw_registrations.compact.map do |h|
+        Orias::Registration.new(h)
+      end
+    end
+
+    def subscribed
+      !registrations_with_status('INSCRIT').empty?
+    end
+
+    # Registrations collections
+
+    def registrations_with_status(status_value)
+      @registrations.select do |registration|
+        registration.status == status_value
+      end
+    end
+
+    private
+
+    class << self
+    end
+  end
+end

data/lib/orias/mandator.rb

@@ -0,0 +1,20 @@
+module Orias
+  # Dedicated to Orias mandators objects handling
+  #
+  class Mandator < Base
+    attr_accessor :raw, :siren, :denomination
+
+    # Initialize an Orias::Mandator instance
+    def initialize(attributes = {})
+      @raw = attributes
+
+      @siren = @raw.dig('siren')
+      @denomination = @raw.dig('denomination')
+    end
+
+    private
+
+    class << self
+    end
+  end
+end

data/lib/orias/registration.rb

@@ -0,0 +1,33 @@
+module Orias
+  # Dedicated to Orias registrations objects handling
+  #
+  class Registration < Base
+    attr_accessor :raw, :category_name, :status, :subscribed,
+      :registration_date, :collect_funds, :mandators
+
+    # Initialize an Orias::Registration instance
+    def initialize(attributes = {})
+      @raw = attributes
+
+      @category_name = @raw.dig('categoryName')
+      @status = @raw.dig('status')
+      @subscribed = @status == 'INSCRIT'
+      @registration_date = @raw.dig('registrationDate')
+      @collect_funds = @raw.dig('collectFunds') == 'true'
+
+      raw_mandators = @raw.dig('mandators', 'mandator')
+      unless raw_mandators.is_a?(Array)
+        raw_mandators = [raw_mandators]
+      end
+
+      @mandators = raw_mandators.compact.map do |h|
+        Orias::Mandator.new(h)
+      end
+    end
+
+    private
+
+    class << self
+    end
+  end
+end

data/lib/orias/request.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+
+module Orias
+  # Dedicated to request handling to ORIAS API
+  #
+  class Request < Base
+    attr_reader   :http, :post, :uri
+    attr_accessor :api_endpoint, :body
+
+    # Initialize an Orias::Request instance
+    def initialize(attributes = {})
+      super
+      @api_endpoint ||= Orias.configuration.api_endpoint
+    end
+
+    # Build the request to be sent
+    def build!
+      @uri = URI(@api_endpoint)
+
+      @post = Net::HTTP::Post.new(uri)
+      @post.body = @body
+      @post['Content-Type'] = 'application/xml'
+
+      @http = Net::HTTP.new(uri.host, uri.port)
+      @http.use_ssl = true
+
+      self
+    end
+
+    # Send the built request
+    def send!
+      build! unless @post && @http
+      @response = @http.request(@post)
+      @response
+    end
+
+    # Return or set #response if not already set
+    def response
+      @response || send!
+    end
+  end
+end

data/lib/orias/response.rb

@@ -0,0 +1,82 @@
+require 'libxml_to_hash'
+
+module Orias
+  # Dedicated to search response handling
+  #
+  class Response < Base
+    VALID_TYPES = [:intermediary_search].freeze
+
+    attr_accessor :type, :raw_response, :raw_hash_response, :results
+
+    # Initialize an Orias::Response instance
+    def initialize(attributes = {})
+      super
+      self.process_raw_response!
+    end
+
+    # Result collections
+
+    [:found, :subscribed].each do |result_attr|
+
+      define_method("#{result_attr}") do |attr_value = true|
+        if @type == :intermediary_search
+          return send("#{result_attr}_intermediaries".to_sym, attr_value)
+        end
+
+        []
+      end
+
+      define_method("not_#{result_attr}") do
+        return send("#{result_attr}".to_sym, false)
+      end
+
+      define_method("#{result_attr}_intermediaries") do |attr_value = true|
+        return send(:results).select do |result|
+          result.send(result_attr) == attr_value
+        end
+      end
+
+    end
+
+    # Result collections methods
+
+    [:found, :not_found].each do |collection|
+
+      [:siren, :orias].each do |intermediary_attr|
+
+        define_method("#{collection}_#{intermediary_attr}") do
+          return send(collection).map do |intermediary|
+            intermediary.send(intermediary_attr)
+          end
+        end
+
+      end
+
+    end
+
+    protected
+
+    def process_raw_response!
+      self.raw_hash_response = Hash.from_libxml(self.raw_response)['Envelope']['Body']
+
+      if @type == :intermediary_search
+        process_intermediary_search!
+      else
+        self
+      end
+    end
+
+    private
+
+    def process_intermediary_search!
+      results_hash = self.raw_hash_response['intermediarySearchResponse']
+      results_hash = results_hash['intermediaries']['intermediary']
+
+      @results = results_hash.map do |h|
+        Orias::Intermediary.new(h)
+      end
+
+      self
+    end
+  end
+end

data/lib/orias/search.rb

@@ -0,0 +1,101 @@
+require 'libxml_to_hash'
+
+module Orias
+  # Dedicated to search request building
+  #
+  class Search < Base
+    VALID_INTERMEDIARIES_TYPE = { siren: 9, registrationNumber: 8 }.freeze
+
+    attr_accessor :client
+
+    # Initialize an Orias::Search instance
+    def initialize(attributes = {})
+      super
+      @client ||= Orias::Client.new
+    end
+
+    # Alias for #find_by with an :orias type
+    def find_by_orias(*terms)
+      find_by(:orias, terms)
+    end
+
+    # Alias for #find_by with an :siren type
+    def find_by_siren(*terms)
+      find_by(:siren, terms)
+    end
+
+    # Request building for intermediarySearchRequest
+    def find_by(type, terms)
+      request = Orias::Request.new(
+        api_endpoint: @client.api_endpoint,
+        body: raw_find(raw_intermediaries(type, terms))
+      ).build!
+
+      Orias::Response.new(
+        type: :intermediary_search,
+        raw_response: request.response.body
+      )
+    end
+
+    # Build the raw request body of a search
+    def raw_body(content)
+      xmlns_url = 'http://schemas.xmlsoap.org/soap/envelope/'
+
+      output = "<soapenv:Envelope xmlns:soapenv=\"#{xmlns_url}\">"
+      output += "<soapenv:Body>#{content}</soapenv:Body>"
+      output + '</soapenv:Envelope>'
+    end
+
+    # Build the raw search request of a search
+    def raw_find(raw_intermeds)
+      content = '<intermediarySearchRequest xmlns="urn:gpsa:orias:ws.001">'
+      content += "<user xmlns=\"\">#{@client.private_key}</user>"
+      content += "<intermediaries xmlns=\"\">#{raw_intermeds}</intermediaries>"
+      content += '</intermediarySearchRequest>'
+
+      raw_body(content)
+    end
+
+    # Build the raw intermediaries list of a search
+    def raw_intermediaries(type, terms)
+      raise 'Orias::Search - You must at least submit one term.' if terms.empty?
+
+      type = Search.set_type(type, terms)
+      terms = Search.set_terms(type, terms)
+
+      terms.flatten.uniq.compact.map do |term|
+        "<intermediary><#{type}>#{term}</#{type}></intermediary>\n"
+      end.join
+    end
+
+    class << self
+      # Check & Set the type for an intermediaries list
+      def set_type(type, terms)
+        type = :registrationNumber if type == :orias
+
+        return type if VALID_INTERMEDIARIES_TYPE.key?(type)
+
+        lgts = terms.map(&:length).uniq
+
+        unless lgts.length == 1 && VALID_INTERMEDIARIES_TYPE.invert[lgts.first]
+          raise "Orias::Search - Unknown Type Error (\"#{type}\")."
+        end
+
+        VALID_INTERMEDIARIES_TYPE.invert[lgts.first]
+      end
+
+      # Check & Set an intermediaries list
+      def set_terms(type, terms)
+        terms.map!{ |t| t.gsub(/\D/,'') }
+        lgts = terms.map(&:length).uniq
+        valid_lgth = VALID_INTERMEDIARIES_TYPE[type]
+
+        unless lgts.length == 1 && lgts.first == valid_lgth
+          raise "Terms for \"#{type}\" must all have a length of #{valid_lgth}."
+        end
+
+        terms
+      end
+    end
+  end
+end

data/lib/orias/version.rb

@@ -1,3 +1,3 @@
 module Orias
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/orias.rb

@@ -1,5 +1,28 @@
+require 'orias/base'
 require 'orias/version'
+require 'orias/configuration'
+require 'orias/request'
+require 'orias/client'
+require 'orias/search'
+require 'orias/response'
+require 'orias/intermediary'
+require 'orias/registration'
+require 'orias/mandator'
 
+# Top-level of the orias ruby gem.
+#
 module Orias
-  # Your code goes here...
+  class << self
+    attr_writer :configuration
+  end
+
+  # Orias::Configuration instance accessor
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Orias::Configuration instance builder
+  def self.configure
+    yield(configuration)
+  end
 end

data/orias.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'orias/version'
 
@@ -15,25 +14,22 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/01max/orias'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency('libxml-to-hash')
+
   spec.add_development_dependency('bundler', '~> 1.16')
+  spec.add_development_dependency('faker', '~> 1.9')
   spec.add_development_dependency('rake', '~> 10.0')
   spec.add_development_dependency('rspec', '~> 3.0')
   spec.add_development_dependency('rubocop')

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: orias
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 01max
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: libxml-to-hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -112,6 +141,15 @@ files:
 - bin/console
 - bin/setup
 - lib/orias.rb
+- lib/orias/base.rb
+- lib/orias/client.rb
+- lib/orias/configuration.rb
+- lib/orias/intermediary.rb
+- lib/orias/mandator.rb
+- lib/orias/registration.rb
+- lib/orias/request.rb
+- lib/orias/response.rb
+- lib/orias/search.rb
 - lib/orias/version.rb
 - orias.gemspec
 homepage: https://github.com/01max/orias