firmapi 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83b3f1632b676cb34fa0dd1d5e07d4b059becc66
+  data.tar.gz: 96d491c658248919a96171211f41dce4c4310a77
+SHA512:
+  metadata.gz: caa57ef54818f727cefca381642e2c0fd60b2628300c79003955ef8393dcd367d56af7aedee41f56fc1830d19ee5e19043cd2fb0d404af055bc9bfc4ea258a01
+  data.tar.gz: f70f67e4a93bc604b627be92134b775e1b0296f97f6af893ee4a605b690da7d73091b50b7c0e510e16130708605a71460786280a90b3a4a8d14e8ed7092ae50a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firmapi.gemspec
+gemspec

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Etienne Depaulis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Firmapi
+
+Firmapi is a ruby client for [Firmapi](https://firmapi.com/) JSON API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firmapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firmapi
+
+## Usage
+
+### Configuration
+
+Firmapi can be configured (ideally inside an initializer) by
+calling Firmapi.configure like so:
+
+    Firmapi.configure do |config|
+      # An api key is mandatory to use the service
+      config.api_key = "123456"
+    end
+
+### Gathering information about a company
+
+#### Using the SIREN number
+
+    company = Firmapi::Company.find_by_siren!(480470152)
+    company.name # => "EVANGELINA"
+    
+    Firmapi::Company.find_by_siren!("INVALID SIREN") # => Firmapi::Company::NoCompanyFound: 'No company was found with the siren 'INVALID SIREN'.'
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Etienne Depaulis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec

data/firmapi.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firmapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firmapi"
+  spec.version       = Firmapi::VERSION
+  spec.authors       = ["Etienne Depaulis"]
+  spec.email         = ["etienne.depaulis@gmail.com"]
+  spec.description   = %q{Firmapi is a ruby client for www.firmapi.com}
+  spec.summary       = %q{Firmapi is a ruby client for www.firmapi.com}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", '~> 10.1.0'
+  spec.add_development_dependency "rspec", '~> 2.99'
+  spec.add_development_dependency "vcr", '~> 2.9'
+  spec.add_development_dependency "webmock", '~> 1.18'
+  spec.add_runtime_dependency     "faraday", '~> 0.9'
+  spec.add_runtime_dependency     "faraday_middleware", '~> 0.9'
+  spec.add_runtime_dependency     "virtus", '~> 1.0'
+end

data/lib/firmapi.rb

@@ -0,0 +1,8 @@
+require "firmapi/version"
+
+module Firmapi
+
+  require 'firmapi/configuration'
+  require 'firmapi/company'
+
+end

data/lib/firmapi/company.rb

@@ -0,0 +1,43 @@
+require 'virtus'
+require 'faraday'
+require 'faraday_middleware'
+
+module Firmapi
+  class Company
+  	include Virtus.model
+
+  	attribute :siren, String
+  	attribute :nic, String
+  	attribute :commercial_name, String
+  	attribute :official_name, String
+  	attribute :name, String
+  	attribute :naf_code, String
+  	attribute :legal_form, String
+  	attribute :address, String
+  	attribute :postal_code, String
+  	attribute :city, String
+  	attribute :vat_number, String
+  	attribute :number_of_establishments, Integer
+  	attribute :registration_date, Date
+  	attribute :cessation_date, Date
+  	attribute :website, String
+
+  	def self.find_by_siren!(siren)
+  		conn = Faraday.new(url: 'https://firmapi.com') do |faraday|
+  			faraday.response :json, content_type: /\bjson$/
+			  faraday.adapter  Faraday.default_adapter
+			end
+
+			response = conn.get '/api/v1/company', { siren: siren, api_key: Firmapi.configuration.api_key}
+
+			if response.status == 200
+				json = response.body
+				self.new(json["result"])
+			elsif response.status == 404
+				raise NoCompanyFound, "No company was found with the siren '#{siren}'."
+			end
+  	end
+
+  	class NoCompanyFound < StandardError ; end
+  end
+end

data/lib/firmapi/configuration.rb

@@ -0,0 +1,13 @@
+module Firmapi
+  class Configuration
+    attr_accessor :api_key
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/firmapi/version.rb

@@ -0,0 +1,3 @@
+module Firmapi
+  VERSION = "0.1"
+end

data/spec/cassettes/find_single_company_with_invalid_siren.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://firmapi.com/api/v1/company?api_key=123456&siren=INVALID%20SIREN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx/1.4.1 (Ubuntu)
+      Date:
+      - Fri, 06 Jun 2014 12:58:53 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-cache
+      Set-Cookie:
+      - request_method=GET; path=/
+      X-Request-Id:
+      - 21e616b5-5e88-46ef-8b80-cab5f520eb4a
+      X-Runtime:
+      - '0.073416'
+    body:
+      encoding: UTF-8
+      string: '{"input":{"siren":"INVALID SIREN"},"result":{"response":"fail","error":"Company
+        not found","description":"No company where found by this siren."}}'
+    http_version:
+  recorded_at: Fri, 06 Jun 2014 12:58:53 GMT
+recorded_with: VCR 2.9.2

data/spec/cassettes/find_single_company_with_valid_siren.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://firmapi.com/api/v1/company?api_key=123456&siren=480470152
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.1 (Ubuntu)
+      Date:
+      - Fri, 06 Jun 2014 12:43:33 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - '"ef8fa7287179f2c5bbd81ec627358a0b"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - request_method=GET; path=/
+      X-Request-Id:
+      - d77bcb08-828e-4f56-8dbb-eb5fc2644a5d
+      X-Runtime:
+      - '0.042333'
+    body:
+      encoding: UTF-8
+      string: '{"input":{"siren":"480470152"},"result":{"siren":"480470152","name":"Norauto
+        France","nic":"00012","commercial_name":null,"official_name":"NORAUTO FRANCE","naf_code":"4532Z","legal_form":"SAS","address":"511
+        589 R Des Seringats","postal_code":"59262","city":"Sainghin En Melantois","vat_number":"FR71480470152","number_of_establishments":230,"registration_date":"2005-01-20","cessation_date":null,"website":"http://centres.norauto.fr/110-norauto-leers?utm_source=google\u0026utm_medium=places\u0026utm_campaign=Norauto_20121219JC","financial_activity":[{"publication_year":2012,"turnover":null,"income":null,"workforce_count":null,"publication_date":"2012-09-29"},{"publication_year":2011,"turnover":null,"income":null,"workforce_count":null,"publication_date":"2011-09-29"},{"publication_year":2010,"turnover":null,"income":null,"workforce_count":null,"publication_date":"2010-09-29"},{"publication_year":2009,"turnover":null,"income":null,"workforce_count":null,"publication_date":"2009-09-29"}]}}'
+    http_version:
+  recorded_at: Fri, 06 Jun 2014 12:43:33 GMT
+recorded_with: VCR 2.9.2

data/spec/company_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Firmapi::Company do
+
+  before(:all) do
+    Firmapi.configure do |config|
+      config.api_key = "123456"
+    end
+  end
+
+  describe ":find_by_siren!" do
+
+    context 'with a valid siren' do
+
+      before(:each) do
+        VCR.use_cassette "find_single_company_with_valid_siren" do
+          @company = Firmapi::Company.find_by_siren!(480470152)
+        end
+      end
+
+      subject(:company) { @company }
+
+      it { expect(subject.name).to eq("Norauto France") }
+      it { expect(subject.siren).to eq("480470152") }
+      it { expect(subject.nic).to eq("00012") }
+      it { expect(subject.commercial_name).to be_nil }
+      it { expect(subject.official_name).to eq("NORAUTO FRANCE") }
+      it { expect(subject.naf_code).to eq("4532Z") }
+      it { expect(subject.legal_form).to eq("SAS") }
+      it { expect(subject.address).to eq("511 589 R Des Seringats") }
+      it { expect(subject.postal_code).to eq("59262") }
+      it { expect(subject.city).to eq("Sainghin En Melantois") }
+      it { expect(subject.vat_number).to eq("FR71480470152") }
+      it { expect(subject.number_of_establishments).to eq(230) }
+      it { expect(subject.registration_date).to eq(Date.new(2005, 1, 20)) }
+      it { expect(subject.cessation_date).to be_nil }
+      it { expect(subject.website).to eq("http://centres.norauto.fr/110-norauto-leers?utm_source=google\u0026utm_medium=places\u0026utm_campaign=Norauto_20121219JC") }
+
+    end
+
+    context 'with an invalid siren' do
+      it "raises an exception" do
+        VCR.use_cassette "find_single_company_with_invalid_siren" do
+          expect{
+            Firmapi::Company.find_by_siren!("INVALID SIREN")
+          }.to raise_error Firmapi::Company::NoCompanyFound
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'VCR'
+
+require_relative '../lib/firmapi.rb'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = false
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: firmapi
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Etienne Depaulis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Firmapi is a ruby client for www.firmapi.com
+email:
+- etienne.depaulis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- firmapi.gemspec
+- lib/firmapi.rb
+- lib/firmapi/company.rb
+- lib/firmapi/configuration.rb
+- lib/firmapi/version.rb
+- spec/cassettes/find_single_company_with_invalid_siren.yml
+- spec/cassettes/find_single_company_with_valid_siren.yml
+- spec/company_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Firmapi is a ruby client for www.firmapi.com
+test_files:
+- spec/cassettes/find_single_company_with_invalid_siren.yml
+- spec/cassettes/find_single_company_with_valid_siren.yml
+- spec/company_spec.rb
+- spec/spec_helper.rb
+has_rdoc: