apralib 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59af58d7a0d079dec4dca4c1532b86e2663ac9e1
+  data.tar.gz: d6d076636dbf8ecff1f567fdb7a9415e5ae4fb80
+SHA512:
+  metadata.gz: ddac87c831ebb1de2e417075b17c3d43f253af1bbbce7a609418a192311ed3cd562fec65b4319920ff88131d51c01cfaab656f74546fc063529b34d3e017bad2
+  data.tar.gz: f01b555e830993def27fcf61ea97e3add099707b84517777bb17d2047e8d0ed5aa1bed9bb38d5a72a74193bd42b7e0fe9a93c7fc6f6d4cd098800091bd7c3f98

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.1.3
+- 1.9.3
+env:
+  global:
+  - secure: XQ58eL4HELhYo0x1RgzyLkAF+XCBzTZLe3NIs4qsc4wIbeIUWVxb6chm/8ikbQn8ndk06EsJrZV/HC08EebUtgb1WTGeaEhyJGdyTVThO2dbLc+wKdrrGcmxiZEd1N6pg0G+4l8QsvMCTWJts6ZhrvVtmle6izGPfF467hLWIjM=
+  - secure: FY5lZvsTluLglsk0j4c4rPXj0BqN80PVUzCLwFtBzhZJ/Dic8c6IGGDy91RQPoR11bcsqQgUhEOeTh0LEjmuGijZ1WIm0/0PynLZe2rxM76OA/ph5KKmYIgi5OLEkWJ8mQRLSeOqpw2BeaqW35MfhX6uItcJbEztiSgVkx01Y4g=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marco Sandrini
+
+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,59 @@
+# Apralib
+
+A Ruby library to submit documents to the Apra Service run by [Maatalousyrittäjien eläkelaitos](http://www.mela.fi)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'apralib'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apralib
+
+## Usage
+
+To use this gem you will need credentials from [Maatalousyrittäjien eläkelaitos](http://www.mela.fi).
+
+Once you have obtained the credentials you can instantiate a client
+
+    ApraService::Client.new(username, password)
+
+you can then create one or more notifications to be sent to the server
+
+    notification = Notification.new
+    grantee = Grantee.new
+    grantee.first_names='Teppo'
+    grantee.last_name = 'Taiteilija'
+    grantee.ssn = '111111-111C'
+    notification.grantee = grantee
+    notification.granted_to_group = false
+    notification.expense_amount = 0
+    notification.amount = 10000
+    notification.purpose = 'My grant purpose'
+    notification.grant_date = Date.today << 1
+    notification.reference = 'My project rede'
+    notification.work_duration_months = 1
+    notification.work_duration_days = 2
+    notification.work_duration_years = 3
+    notification.work_start_date = Date.today
+    notification.work_end_date = Date.today >> 1
+    service.send_notifications(notification)
+
+As the information passed through the notification is dependent on the statutory earnings-related pension of those receiving
+a grant or a scholarship from Finland, this readme does not explain the meaning of the different fields in the notification
+object. For further information please refer to the [Mela website](http://www.mela.fi)
+
+
+## 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

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+YARD::Rake::YardocTask.new('yard')
+
+task :default => :spec

data/apralib.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apralib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apralib'
+  spec.version       = Apralib::VERSION
+  spec.authors       = ['Marco Sandrini']
+  spec.email         = ['nessche@gmail.com']
+  spec.description   = %q{A Ruby client for the Apra Service}
+  spec.summary       = %q{A Ruby library to submit documents to the Apra Service run by Maatalousyrittäjien eläkelaitos}
+  spec.homepage      = 'https://github.com/nessche/apralib'
+  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'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'yard'
+  spec.add_dependency 'savon', '~> 2.3.0'
+end

data/lib/apralib/apra_service.rb

@@ -0,0 +1,32 @@
+require_relative 'notification'
+require_relative 'response'
+require 'savon'
+
+module ApraService
+
+  class Client
+
+    def initialize(username, password)
+      @client = Savon.client(wsdl: 'https://palvelu.mela.fi/Apurahailmoitukset/ws/apurahanSyottoWS?wsdl',
+                             wsse_auth: [username, password],
+                             endpoint: 'https://palvelu.mela.fi/Apurahailmoitukset/ws/apurahanSyottoWS')
+    end
+
+    def send_notifications(notifications)
+      raise ArgumentError, 'notifications object cannot be nil' unless notifications
+      raise ArgumentError, 'notifications object must be either a Notification object or an array of Notification objects' unless
+          (notifications.is_a? Notification or (notifications.is_a? Array and notifications.detect {|n| !n.is_a? Notification}.nil?))
+      notifications = [notifications] unless notifications.is_a? Array
+      message = {}
+      message[:arg0] = notifications.map {|notification| notification.to_hash}
+      response = @client.call(:lisaa_apurahat, :message => message)
+      raise RuntimeError, 'An error occurred while submitting the notification' unless response.success?
+      Response.from_hash(response.body)
+    end
+
+
+
+  end
+
+
+end

data/lib/apralib/grantee.rb

@@ -0,0 +1,63 @@
+module ApraService
+
+  class Grantee
+
+    SSN_REGEX = /(\d{6})([-+A])(\d{3})([0-9ABCDEFHJKLMNPRSTUVWXY])/
+    CHECK_DIGITS = %w(0 1 2 3 4 5 6 7 8 9 A B C D E F H J K L M N P R S T U V X Y)
+
+    attr_accessor :first_names, :last_name, :ssn, :address, :zip
+
+    def to_hash
+      result = {}
+      result[:apurahansaajanosoite] = address if address
+      result[:apurahansaajanpostinumero] = zip if zip
+      first_names.split(' ')[0..2].each_with_index do |name, index|
+        result["etunimi#{index + 1}".to_sym] = name
+      end
+      result[:henkilotunnus] = ssn if ssn
+      result[:sukunimi] = last_name
+
+      result
+
+    end
+
+    def self.from_hash(hash)
+      grantee = Grantee.new
+      grantee.address = hash[:apurahansaajanosoite]
+      grantee.zip = hash[:apurahansaajanpostinumero]
+      grantee.first_names = [hash[:etunimi1]]
+      grantee.first_name << hash[:etunimi2] if hash[:etunimi2]
+      grantee.first_name << hash[:etunimi3] if hash[:etunimi3]
+      grantee.ssn = hash[:henkilotunnus]
+      grantee.last_name = hash[:sukunimi]
+      grantee
+    end
+
+    def ssn=(ssn)
+      Grantee.verify_ssn!(ssn)
+      self.instance_variable_set('@ssn', ssn)
+    end
+
+    def self.verify_ssn!(ssn)
+      raise RuntimeError, 'The Social Security Number is not in the correct format' unless ssn =~ SSN_REGEX
+      big_number = "#{$1}#{$3}".to_i
+      check = CHECK_DIGITS[big_number % 31]
+      raise RuntimeError, "The check digit does not match, expected #{check}, got #{$4}" unless check == $4
+    end
+
+    def self.verify_ssn(ssn)
+      begin
+        verify_ssn! ssn
+          true
+      rescue RuntimeError => e
+        puts e.message
+        false
+      end
+    end
+
+
+
+
+  end
+
+end

data/lib/apralib/notification.rb

@@ -0,0 +1,79 @@
+module ApraService
+
+  class Notification
+
+    attr_accessor :purpose, :purpose_description, :expense_amount, :expense_description,
+                  :grant_date, :granted_to_group, :amount, :grantee, :work_start_date,
+                  :work_end_date, :reference, :work_duration_months, :work_duration_days,
+                  :work_duration_years, :ignore_work_duration
+
+    NON_NILLABLE_KEYS = [:purpose, :expense_amount, :grant_date, :granted_to_group, :work_duration_months,
+                        :work_duration_days, :work_duration_years, :grantee, :amount, :ignore_work_duration]
+
+
+    def initialize
+      @ignore_work_duration = false
+      @granted_to_group = false
+      @work_duration_days = 0
+      @work_duration_months = 0
+      @work_duration_years = 0
+      @expense_amount = 0
+    end
+
+    def to_hash
+      NON_NILLABLE_KEYS.each do |key|
+        raise RuntimeError, "Variable #{key.to_s} cannot be nil" if self.instance_variable_get("@#{key.to_s}").nil?
+      end
+      result = {}
+      result[:kayttotarkoitus] = purpose
+      result[:kayttotarkoitustarkenne] = purpose_description if purpose_description
+      result[:kuluosuusrahamaara] = expense_amount
+      result[:kuluosuusteksti] = expense_description if expense_description
+      result[:myontopaatoksen_antopvm] = grant_date.rfc3339
+      result[:onko_myonnetty_tyoryhmalle] = granted_to_group
+      result[:rahamaara] = amount
+      result[:saajatiedot] = grantee.to_hash
+      result[:sisaltaako_kuluja] = (expense_amount > 0)
+
+      if ignore_work_duration
+        result[:tyon_kesto_kuukausia] = 0
+        result[:tyon_kesto_paivia] = 0
+        result[:tyon_kesto_vuosia] = 0
+      else
+        result[:tyon_kesto_kuukausia] = work_duration_months
+        result[:tyon_kesto_paivia] = work_duration_days
+        result[:tyon_kesto_vuosia] = work_duration_years
+      end
+      result[:tyonkestoeikantaa] = ignore_work_duration
+      result[:tyoskentelyn_alkamispvm] = work_start_date.rfc3339 if work_start_date
+      result[:tyoskentelyn_paattymispvm] = work_end_date.rfc3339 if work_end_date
+      result[:viite] = reference
+      result
+
+    end
+
+    def self.from_hash(hash)
+      notification = Notification.new
+      notification.purpose = hash[:kayttotarkoitus]
+      notification.purpose_description = hash[:kayttotarkoitustarkenne]
+      notification.expense_amount = hash[:kuluosuusrahamaara]
+      notification.expense_description = hash[:kuluosuusteksti]
+      notification.grant_date = hash[:myontopaatoksen_antopvm]
+      notification.granted_to_group = hash[:onko_myonnetty_tyoryhmalle]
+      notification.amount = hash[:rahamaara]
+      notification.grantee = Grantee.from_hash(hash[:saajatiedot])
+      notification.work_duration_months = hash[:tyon_kesto_kuukausia]
+      notification.work_duration_days = hash[:tyon_kesto_paivia]
+      notification.work_duration_years = hash[:tyon_kesto_vuosia]
+      notification.ignore_work_duration = hash[:tyonkestoeikantaa]
+      notification.work_start_date = hash[:tyoskentelyn_alkamispvm]
+      notification.work_end_date = hash[:tyoskentelyn_paattymispvm]
+      notification.reference = hash[:viite]
+      notification
+    end
+
+
+  end
+
+
+end

data/lib/apralib/notification_response.rb

@@ -0,0 +1,23 @@
+module ApraService
+
+  class NotificationResponse
+
+    attr_accessor :notification, :error
+
+    def initialize(notification, error)
+      @notification = notification
+      @error = error
+    end
+
+
+    def self.from_hash(hash)
+      notification = Notification.from_hash(hash[:ilmoitus])
+      error = hash[:virhe]
+      NotificationResponse.new(notification, error)
+    end
+
+
+  end
+
+
+end

data/lib/apralib/response.rb

@@ -0,0 +1,28 @@
+module ApraService
+
+  class Response
+
+    attr_accessor :failed_notifications
+
+
+    def self.from_hash(hash)
+      puts hash.inspect
+      response = Response.new
+      raw_response = hash[:lisaa_apurahat_response]
+      failures = raw_response[:epaonnistuneet_ilmoitukset]
+      if failures
+        failures = [failures] unless failures.is_a? Array
+        response.failed_notifications = failures.map {|notification| NotificationResponse.from_hash(notification) }
+      else
+        response.failed_notifications = []
+      end
+      response
+    end
+
+
+  end
+
+
+
+
+end

data/lib/apralib/version.rb

@@ -0,0 +1,3 @@
+module Apralib
+  VERSION = "0.0.1"
+end

data/lib/apralib.rb

@@ -0,0 +1,8 @@
+require 'apralib/version'
+require 'apralib/apra_service'
+require 'apralib/notification'
+require 'apralib/grantee'
+require 'apralib/response'
+require 'apralib/notification_response'
+
+

data/spec/lib/apra_service_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require 'apralib'
+
+module ApraService
+
+
+  describe 'Client' do
+
+    def get_client
+      credentials = {}
+      credentials_file = File.join(File.dirname(__FILE__), 'apra_credentials.yml')
+      credentials = YAML.load(File.read(credentials_file)) if File.exists?(credentials_file)
+      user = credentials['user'] || ENV['APRA_USER']
+      password = credentials['password'] || ENV['APRA_PASSWORD']
+      Client.new(user, password)
+    end
+
+
+    describe 'initialize' do
+
+      it 'should create a valid object' do
+
+        service = Client.new('user','password')
+        expect(service).not_to be_nil
+
+      end
+
+      it 'should send the notification to the server' do
+
+        service = get_client
+        notification = Notification.new
+        grantee = Grantee.new
+        grantee.first_names='Teppo'
+        grantee.last_name = 'Taiteilija'
+        grantee.ssn = '111111-111C'
+        notification.grantee = grantee
+        notification.granted_to_group = false
+        notification.expense_amount = 0
+        notification.amount = 10000
+        notification.purpose = 'Patsaan rakentaminen'
+        notification.grant_date = Date.today << 1
+        notification.reference = SecureRandom.hex(16)
+        notification.work_duration_months = 1
+        notification.work_duration_days = 2
+        notification.work_duration_years = 3
+        notification.ignore_work_duration = true
+        notification.work_start_date = Date.today
+        notification.work_end_date = Date.today >> 1
+        notification1 = Notification.new
+        notification1.grantee = grantee
+        notification1.granted_to_group = false
+        notification1.expense_amount = 0
+        notification1.amount = 10000
+        notification1.purpose = 'Patsaan rakentaminen'
+        notification1.grant_date = Date.today << 1
+        notification1.reference = SecureRandom.hex(10)
+        notification1.work_duration_months = 1
+        notification1.work_duration_days = 2
+        notification1.work_duration_years = 3
+        notification1.ignore_work_duration = true
+        notification1.work_start_date = Date.today
+        notification1.work_end_date = Date.today >> 1
+        response = service.send_notifications([notification, notification1])
+        expect(response).not_to be_nil
+        failed_notifications = response.failed_notifications
+        expect(failed_notifications).not_to be_nil
+        expect(failed_notifications).to be_a Array
+        expect(failed_notifications.count).to eq(1)
+        notification_response = failed_notifications[0]
+        expect(notification_response.error).not_to be_nil
+        expect(notification_response.notification.reference).to eq(notification.reference)
+      end
+
+
+
+
+    end
+
+
+
+  end
+
+
+
+
+end

data/spec/lib/grantee_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'apralib'
+
+module ApraService
+
+  describe 'Grantee' do
+
+    describe 'verify_ssn' do
+
+      it 'should return true when the ssn is valid' do
+        expect(Grantee.verify_ssn('111111-111C')).to be_truthy
+      end
+
+
+    end
+
+    describe 'verify_ssn!' do
+
+      it 'should not throw any exception when the ssn is valid' do
+        expect{Grantee.verify_ssn!('111111-111C')}.not_to raise_error
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: apralib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marco Sandrini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: A Ruby client for the Apra Service
+email:
+- nessche@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apralib.gemspec
+- lib/apralib.rb
+- lib/apralib/apra_service.rb
+- lib/apralib/grantee.rb
+- lib/apralib/notification.rb
+- lib/apralib/notification_response.rb
+- lib/apralib/response.rb
+- lib/apralib/version.rb
+- spec/lib/apra_service_spec.rb
+- spec/lib/grantee_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nessche/apralib
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby library to submit documents to the Apra Service run by Maatalousyrittäjien
+  eläkelaitos
+test_files:
+- spec/lib/apra_service_spec.rb
+- spec/lib/grantee_spec.rb
+- spec/spec_helper.rb
+has_rdoc: