ytj_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8eae097f8325e466a4593e4960afff09fc8db03
+  data.tar.gz: af32f6468f790c419c4cc04816575198de4f77d1
+SHA512:
+  metadata.gz: fe5c1dbcdb5dff384d998fb0d7454e7c6b9214d884746aeace174ce37dfd3e2f65533d8ac1acdfe11a1d89587baaee915e9a75764f247050d319f0256bef9b07
+  data.tar.gz: 0605aa009b316bd33ad408e727723caceced144b99fb689229508e026d22801b1741151b278fb109d90d14ac488cbf71021546891bea179aafcd94317de5241a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright (c) 2016 Janne Warén
+
+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,46 @@
+# ytj_client
+
+A really small gem to fetch and parse data from the Finnish Patent and Registration Office's (PRH) YTJ-tiedot (business information system) API at http://avoindata.prh.fi/ytj.html
+
+Makes the API call for you and parses the relevant (in my opinion) information to a convenient format (Ruby hash).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ytj_client'
+```
+
+And then execute:
+
+    $ bundle intall
+
+Or install it yourself as:
+
+    $ gem install ytj_client
+
+## Usage
+
+Currently only supports getting company information with a business_id:
+
+```ruby
+require 'ytj_client'
+
+YtjClient.fetch_company('2331972-7')
+# => #Hash {
+#           :business_id => "2331972-7",
+#                  :name => "Verso Food Oy",
+#     :registration_date => "2010-04-20",
+#          :company_form => "OY",
+#                :phones => {
+#         :mobile_phone => "+358400770697"
+#     },
+#               :website => "www.versofood.fi",
+#             :addresses => {
+#         :visiting_address => "Loisteputki 4, 00750, HELSINKI",
+#           :postal_address => "Loisteputki 4, 00750, HELSINKI"
+#     }
+# }
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ytj_client"
+
+# 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"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ytj_client/version.rb

@@ -0,0 +1,3 @@
+module YtjClient
+  VERSION = "0.2.0"
+end

data/lib/ytj_client.rb

@@ -0,0 +1,85 @@
+require "ytj_client/version"
+require 'logger'
+
+module YtjClient
+
+  YTJ_API_URL = 'http://avoindata.prh.fi:80/bis/v1/'.freeze
+
+  class << self
+
+    # Public method to be called
+    # for now returns a set of data that I think is generally useful
+    def fetch_company(business_id)
+      ytj_data = api_call(business_id)
+      {
+        business_id:        ytj_data["businessId"],
+        name:               ytj_data["name"],
+        registration_date:  ytj_data["registrationDate"],
+        company_form:       ytj_data["companyForm"],
+        phones:             parse_phones(ytj_data),
+        website:            parse_website(ytj_data),
+        addresses:          parse_addresses(ytj_data)
+      }
+    rescue RestClient::NotFound
+      logger.warn "Company #{business_id} not found"
+      nil
+    rescue
+      logger.error "Error fetching data from YTJ: #{$!.message} - #{$!.backtrace}"
+    end
+
+    private
+
+      # Returns a hash with all company data from YTJ
+      def api_call(business_id)
+        url = "#{YTJ_API_URL}#{business_id}"
+        response = RestClient.get url
+        JSON.parse(response.body)["results"][0]
+      end
+
+      def parse_phones(ytj_data)
+        phones = {}
+        mobile_phone = ytj_data["contactDetails"].select { |contact| contact["type"] =="Mobile phone" && contact["endDate"] == nil  }.first
+        phone = ytj_data["contactDetails"].select { |contact| contact["type"] =="Telephone" && contact["endDate"] == nil  }.first
+        phones[:phone] = phone["value"].delete(' ') if phone
+        phones[:mobile_phone] = mobile_phone["value"].delete(' ') if mobile_phone
+        return phones
+      end
+
+      def parse_website(ytj_data)
+        website = ytj_data["contactDetails"].select { |contact| contact["type"] =="Website address" && contact["endDate"] == nil  }.first
+        website["value"] if website
+      end
+
+      def parse_addresses(ytj_data)
+        addresses = {}
+        visiting_address =ytj_data["addresses"].select { |address| address["type"] == 1 && address["endDate"] == nil  }.first
+        postal_address = ytj_data["addresses"].select { |address| address["type"] == 2 && address["endDate"] == nil  }.first
+        addresses[:visiting_address] = parse_address(visiting_address)
+        addresses[:postal_address] = parse_address(postal_address)
+        return addresses
+      end
+
+      def parse_address(address)
+        result = []
+        result << address['careOf']
+        result << address['street']
+        result << address['postCode']
+        result << address['city']
+        result << address['country']
+        result.compact!
+        result.join(', ')
+      end
+
+      def parse_business_lines(ytj_data)
+        business_lines = []
+        ytj_data["businessLines"].select{|line| line["language"] == "FI"}.each do |business_line|
+          business_lines << business_line["name"]
+        end
+        business_lines
+      end
+
+      def logger
+        @logger ||= Logger.new('log/ytj_client.log')
+      end
+  end
+end

data/ytj_client.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ytj_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ytj_client"
+  spec.version       = YtjClient::VERSION
+  spec.authors       = ["Janne Warén"]
+  spec.email         = ["janne.waren@iki.fi"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'Client for communicating with Finnish Patent and Registration Office (PRH) YTJ-tiedot API'
+  spec.description   = 'Fetches data with business_id from the YTJ API at http://avoindata.prh.fi/ytj.html'
+  spec.homepage      = 'https://github.com/jannewaren/ytj_client'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency 'awesome_print', '~> 1.7', '>= 1.7.0'
+
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: ytj_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Janne Warén
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Fetches data with business_id from the YTJ API at http://avoindata.prh.fi/ytj.html
+email:
+- janne.waren@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ytj_client.rb
+- lib/ytj_client/version.rb
+- log/.keep
+- ytj_client.gemspec
+homepage: https://github.com/jannewaren/ytj_client
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Client for communicating with Finnish Patent and Registration Office (PRH)
+  YTJ-tiedot API
+test_files: []