roqua-core-api 0.0.32 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 678e4ae5c7c3d16615d18e6e281cf91fa4914cda
-  data.tar.gz: 05a66bcca78f102d0ea61ade9f2c1eb124e4375f
+  metadata.gz: 701130ae6447552bed7bee8edbcd3d48ba391b6a
+  data.tar.gz: 83ad356c5bca77d648987dea22375e28488ea079
 SHA512:
-  metadata.gz: ca4c68a9e732b0f87396e78178e43057662ce88a84924ab7fc553fecab9fb01a0933b0c6cfa058fc7b4a1b46baf7de1b070d3ccddf3e94884f5eddce828055b0
-  data.tar.gz: c23e665fb6b1e359c71bd2bf3e46638b1d234dc32e101fad6a11b88f93c1ed1711bf51b9eb5f620568ebf6f3124b83482015cbef55ccbb7ef83b855994e02d57
+  metadata.gz: 8defee938b1216b71a59e0df9c14aff435c8514726d74b884e53a7ef200603e21489186eea51ee993718d8dc0b82196de78c05a885a28c059facdd167c005129
+  data.tar.gz: a87210e3565bbadac2853a9ba247777ea7a0a2cc5bb3ab04a6f15c039d8f10cfb644b913cd31ed329a1063a01ae22e4a8df460e400eeb03a826b02c05e6df064

data/.yardopts

@@ -1 +1,2 @@
 --markup markdown --title "core_api Documentation" --protected
+- 'config/locales/validation_errors.yml'

data/ChangeLog.md

@@ -1,3 +1,16 @@
+### 0.0.35 / 20114-09-15
+
+* CreateProfessional accepts new parameters: email_subject and email_body.
+* SendInviteEmail accepts new parameters: email_subject and email_body
+
+### 0.0.34 / 2014-08-25
+
+* New dossier creation endpoint. No api change.
+
+### 0.0.33 / 2014-07-30
+
+* Added search options with_name and with_identifier to the api.
+
 ### 0.0.31 / 2014-05-14
 
 * Added translations files for errors we return

data/config/locales/validation_errors.yml

@@ -1,3 +1,5 @@
+# @markup ruby
+# @title Translations
 nl:
   errors: &errors
     format: ! '%{attribute} %{message}'

data/lib/roqua/core_api/create_dossier.rb

@@ -7,9 +7,8 @@ module Roqua
       hash :attributes, strip: false
 
       def execute
-        response = session.post "/dossiers", person: attributes.delete(:person),
-                                             dossier: attributes,
-                                             dossier_group_id: dossier_group_id
+        response = session.post "/dossier_groups/#{dossier_group_id}/dossiers",
+                                person: attributes.delete(:person), dossier: attributes
         Models::Dossier.new(response)
       end
     end

data/lib/roqua/core_api/create_professional.rb

@@ -5,10 +5,11 @@ module Roqua
       model :session, class: Sessions::OAuthSession
       string :dossier_group_id
       model :person, class: Models::Person
+      string :email_subject, default: nil
+      string :email_body, default: nil
 
       def execute
-        response = session.post "/dossier_groups/#{dossier_group_id}/people",
-                                person: person.as_json
+        response = session.post "/dossier_groups/#{dossier_group_id}/people", params
         if response.code == 422
           errors_to_object(response, person)
           person
@@ -16,6 +17,13 @@ module Roqua
           Models::Person.new(response['person'])
         end
       end
+
+      def params
+        {
+          person: person.as_json,
+          email_subject: email_subject, email_body: email_body
+        }.delete_if { |k, v| v.nil? }
+      end
     end
   end
 end

data/lib/roqua/core_api/dossiers.rb

@@ -3,15 +3,30 @@ module Roqua
     # @api private
     class Dossiers < Base
       model :session, class: Sessions::OAuthSession
+      string :dossier_group_id, default: nil
+      string :with_name, default: nil
+      string :with_external_identifier, default: nil
+
+      validates :dossier_group_id, presence: true, if: :with_external_identifier?
 
       # usage:
       # Roqua.CoreApi.Dossiers.run!.each do |d|
-      #   puts d.id, d.birth_year, d.gender
+      #   puts d.id, d.birth_year, d.gender, d.firstname, d.lastname
       # end
       def execute
-        response = session.get "/dossiers"
+        response = session.get "#{url_prefix}/dossiers", params
         create_enum(response['headers'], response['rows'])
       end
+
+      def url_prefix
+        dossier_group_id.present? ? "/dossier_groups/#{dossier_group_id}" : ''
+      end
+
+      def params
+        {name: with_name,
+         external_identifier: with_external_identifier
+        }.delete_if { |k, v| v.nil? }
+      end
     end
   end
 end

data/lib/roqua/core_api/send_invite_email.rb

@@ -4,9 +4,19 @@ module Roqua
     class SendInviteEmail < ActiveInteraction::Base
       model :session, class: Sessions::OAuthSession
       string :dossier_id
+      string :email_subject, default: nil
+      string :email_body, default: nil
 
       def execute
-        session.post "/dossiers/#{dossier_id}/send_invite_email"
+        session.post "/dossiers/#{dossier_id}/send_invite_email", params
+      end
+
+      private
+
+      def params
+        {
+          email_subject: email_subject, email_body: email_body
+        }.delete_if { |k, v| v.nil? }
       end
     end
   end

data/lib/roqua/core_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module CoreApi
-    VERSION = '0.0.32'
+    VERSION = '0.0.35'
   end
 end

data/spec/lib/roqua/core_api/create_dossier_spec.rb

@@ -4,18 +4,16 @@ describe CreateDossier do
   let(:session) { Fabricate :oauth_session }
 
   it 'performs a post on the /dossiers api path' do
-    expect(session).to receive(:post).with '/dossiers', person: 'person',
-                                                        dossier: {other: 'attributes'},
-                                                        dossier_group_id: 'some_dossier_group_id'
+    expect(session).to receive(:post).with '/dossier_groups/some_dossier_group_id/dossiers',
+                                           person: 'person', dossier: {other: 'attributes'}
     CreateDossier.run!(session: session,
                        attributes: {person: 'person', other: 'attributes'},
                        dossier_group_id: 'some_dossier_group_id')
   end
 
   it 'returns a Dossier model' do
-    allow(session).to receive(:post).with('/dossiers', person: 'person',
-                                                       dossier: {other: 'attributes'},
-                                                       dossier_group_id: 'some_dossier_group_id')
+    allow(session).to receive(:post).with('/dossier_groups/some_dossier_group_id/dossiers',
+                                          person: 'person', dossier: {other: 'attributes'})
                                     .and_return 'id' => 'some_id'
     dossier = CreateDossier.run!(session: session,
                                  attributes: {person: 'person', other: 'attributes'},

data/spec/lib/roqua/core_api/dossiers_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Dossiers do
+  let(:session) { Fabricate :oauth_session }
+  let(:dossier_group_id) { 'some_dg_id' }
+  let(:external_identifier) { 'some_eid' }
+  let(:response) { {'headers' => %w(id birth_year gender firstname lastname),
+                    'rows' => [[1, 1980, 'M', 'john', 'doe']]} }
+
+  it 'performs a get on the /dossiers api path' do
+    expect(session).to receive(:get).with('/dossiers', {}).and_return(response)
+    Dossiers.run!(session: session)
+  end
+
+  it 'performs a get on /dossier_groups/:id/dossiers if a group is given' do
+    expect(session).to receive(:get).with("/dossier_groups/#{dossier_group_id}/dossiers", {}).and_return(response)
+    Dossiers.run!(session: session, dossier_group_id: dossier_group_id)
+  end
+
+  it 'performs a get on /dossier_groups/:id/dossiers?external_identifier=:eid if with_external_identifier is given' do
+    expect(session).to receive(:get).with(
+      "/dossier_groups/#{dossier_group_id}/dossiers", external_identifier: external_identifier).and_return(response)
+    Dossiers.run!(session: session, dossier_group_id: dossier_group_id,
+                  with_external_identifier: external_identifier)
+  end
+
+  it 'performs a get on /dossier_groups/:id/dossiers?name=:foo+bar if with_name is given' do
+    expect(session).to receive(:get).with(
+      "/dossier_groups/#{dossier_group_id}/dossiers", name: 'foo bar').and_return(response)
+    Dossiers.run!(session: session, dossier_group_id: dossier_group_id, with_name: 'foo bar')
+  end
+
+  it 'fails when a search is done for external_identifier without specifying a dossier_group_id' do
+    op = Dossiers.run(session: session, with_external_identifier: external_identifier)
+    expect(op).to be_invalid
+  end
+
+  it 'returns the results as an array of structs' do
+    expect(session).to receive(:get).with('/dossiers', {}).and_return(response)
+    dossiers = Dossiers.run!(session: session)
+    expect(dossiers.force[0].firstname).to eq 'john'
+  end
+end

data/spec/lib/roqua/core_api/send_invite_email_spec.rb

@@ -4,7 +4,11 @@ describe SendInviteEmail do
   let(:session) { Fabricate :oauth_session }
 
   it 'performs a post on the send_invite_email api path' do
-    expect(session).to receive(:post).with '/dossiers/some_dossier_id/send_invite_email'
-    SendInviteEmail.run!(session: session, dossier_id: 'some_dossier_id')
+    expect(session).to receive(:post).with '/dossiers/some_dossier_id/send_invite_email',
+                                           email_subject: 'account created',
+                                           email_body: 'visit %create_account_link% to set password'
+    SendInviteEmail.run!(session: session, dossier_id: 'some_dossier_id',
+                         email_subject: 'account created',
+                         email_body: 'visit %create_account_link% to set password')
   end
 end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: roqua-core-api
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.35
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: active_interaction
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: fabrication
   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.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 description: Provides authenticated access to Core
@@ -170,10 +170,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .yardopts
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
 - ChangeLog.md
 - Gemfile
 - Guardfile
@@ -216,6 +216,7 @@ files:
 - spec/fabricators/oauth_session_fabricator.rb
 - spec/lib/roqua/core_api/create_dossier_group_spec.rb
 - spec/lib/roqua/core_api/create_dossier_spec.rb
+- spec/lib/roqua/core_api/dossiers_spec.rb
 - spec/lib/roqua/core_api/models/active_virtus_spec.rb
 - spec/lib/roqua/core_api/models/person_spec.rb
 - spec/lib/roqua/core_api/send_email_to_spec.rb
@@ -234,17 +235,17 @@ 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
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around Core's API
@@ -255,6 +256,7 @@ test_files:
 - spec/fabricators/oauth_session_fabricator.rb
 - spec/lib/roqua/core_api/create_dossier_group_spec.rb
 - spec/lib/roqua/core_api/create_dossier_spec.rb
+- spec/lib/roqua/core_api/dossiers_spec.rb
 - spec/lib/roqua/core_api/models/active_virtus_spec.rb
 - spec/lib/roqua/core_api/models/person_spec.rb
 - spec/lib/roqua/core_api/send_email_to_spec.rb
@@ -263,3 +265,4 @@ test_files:
 - spec/lib/roqua/core_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/core_api/sessions/oauth_session_spec.rb
 - spec/spec_helper.rb
+has_rdoc: