roqua-core-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854a84f222ad107d7e8201a97f906fcac3f492bb
-  data.tar.gz: 2624aacd6d166cb8f3b3c4b38518f4500175421a
+  metadata.gz: 308a75b5ae9970af2182e36ef88ec844f7cb4254
+  data.tar.gz: 30577d7f7ab41d5c3eac4b1b27ac2afbd9c81a7e
 SHA512:
-  metadata.gz: c2671c1a0bece7bb7a042398ed6c42edd558e84dcfa6fe4d495157404fbd0262358591b9e0d24d7057944b25fd959222ed8c552feb4636bee5e12771c7f5b390
-  data.tar.gz: e6d9331cf5c39ce4687ea78a129060e74bd69176650f333945feb2dfc5e325ed69448a2f30dcd6418d81438fc010bd7b524a916a1870292957f260ee6ddee1dd
+  metadata.gz: f9a0589c49f1b1ea0e13558b0bfff9cb8259dcb76918bf9e4cb026bafcba234037be125eec9077f3ab401e1944965b9d6d7a0fa4304749aead4f09a49cb1ab7d
+  data.tar.gz: b8e9613348b94353fcf4ea278b606b755682b3c9a8de4001b89e52c4e10cb4cbcf979a6f6a4142d8ce6b389024610ded6154f49c8f5ed8e45172058b328a2227

data/ChangeLog.md

@@ -1,3 +1,5 @@
+* Added TokenSession model and CreateTokenSession, DestroyTokenSession usecases.
+
 ### 0.1.0
 
 * BACKWARD INCOMPATIBLE: CreateDossier now needs a dossier and a person object.

data/config/locales/validation_errors.yml

@@ -46,6 +46,11 @@ nl:
         invalid: is ongeldig
         invalid_type: is geen geldige %{type}
         missing: is vereist
+      models:
+        roqua/core_api/create_token_session:
+          attributes:
+            base:
+              not_found: Username or password incorrect.
     types:
       array: array
       boolean: boolean

data/lib/i18n/{i18n.rb → core_api_i18n.rb}

@@ -1,8 +1,8 @@
 begin
   require 'rails'
   module I18n
-    class Railtie < ::Rails::Railtie #:nodoc:
-      initializer 'rails-i18n' do |app|
+    class CoreApiRailtie < ::Rails::Railtie #:nodoc:
+      initializer 'rails-i18n' do
         I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/../../config/locales'), '*.yml')]
         I18n.load_path.flatten!
       end

data/lib/roqua-core-api.rb

@@ -1 +1,2 @@
-require 'roqua/core_api'
+require ::File.expand_path('../roqua/core_api', __FILE__)
+require ::File.expand_path('../i18n/core_api_i18n', __FILE__)

data/lib/roqua/core_api.rb

@@ -3,27 +3,31 @@ require 'roqua/core_api/version'
 require 'roqua/core_api/sessions'
 require 'roqua/core_api/models'
 require 'roqua/core_api/base'
-require 'roqua/core_api/dossiers'
-require 'roqua/core_api/dossier_groups'
-require 'roqua/core_api/list_dossier_group_rights'
-require 'roqua/core_api/delete_dossier_group_right'
-require 'roqua/core_api/create_professional'
-require 'roqua/core_api/create_dossier'
-require 'roqua/core_api/create_dossier_group'
-require 'roqua/core_api/send_email_to'
-require 'roqua/core_api/send_invite_email'
-require 'roqua/core_api/people'
-require 'roqua/core_api/person'
-require 'roqua/core_api/update_person'
-require 'roqua/core_api/update_dossier'
-require 'roqua/core_api/create_dossier_group_export_synchronously'
 
 module Roqua
   module CoreApi
+    extend ActiveSupport::Autoload
     # Raised when a request failed due to an expired/non-existant session.
     class NoSession < StandardError; end
     class Unauthorized < StandardError; end
 
+    autoload :CreateDossier
+    autoload :CreateDossierGroup
+    autoload :CreateDossierGroupExportSynchronously
+    autoload :CreateProfessional
+    autoload :CreateTokenSession
+    autoload :DestroyTokenSession
+    autoload :Dossiers
+    autoload :DossierGroups
+    autoload :DeleteDossierGroupRight
+    autoload :ListDossierGroupRights
+    autoload :People
+    autoload :Person
+    autoload :SendEmailTo
+    autoload :SendInviteEmail
+    autoload :UpdatePerson
+    autoload :UpdateDossier
+
     def self.load_fabricators
       gem_root = Gem::Specification.find_by_name("roqua-core-api").gem_dir
       Fabrication::Config.path_prefixes << gem_root unless Fabrication::Config.path_prefixes.include? gem_root

data/lib/roqua/core_api/base.rb

@@ -15,6 +15,14 @@ module Roqua
           end
         end
       end
+
+      def errors_to_usecase(response)
+        (response['errors'] || []).each do |attribute, resp_errors|
+          resp_errors.each do |error|
+            errors.add(attribute.to_sym, error.to_sym)
+          end
+        end
+      end
     end
   end
 end

data/lib/roqua/core_api/create_token_session.rb

@@ -0,0 +1,20 @@
+module Roqua
+  module CoreApi
+    # @api private
+    class CreateTokenSession < Base
+      string :organization_id
+      string :username
+      string :password
+
+      def execute
+        response = CoreApi.basic_auth_session.post \
+          "/organizations/#{organization_id}/token_sessions",
+          username: username, password: password
+        if response.code == 422
+          errors_to_usecase response
+        end
+        response['token_session']
+      end
+    end
+  end
+end

data/lib/roqua/core_api/destroy_token_session.rb

@@ -0,0 +1,13 @@
+module Roqua
+  module CoreApi
+    # @api private
+    class DestroyTokenSession < Base
+      model :session, class: Sessions::TokenSession
+      string :organization_id
+
+      def execute
+        session.delete "/organizations/#{organization_id}/token_sessions"
+      end
+    end
+  end
+end

data/lib/roqua/core_api/sessions.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 require 'roqua/core_api/sessions/auth_session'
 require 'roqua/core_api/sessions/oauth_session'
+require 'roqua/core_api/sessions/token_session'
 require 'roqua/core_api/sessions/basic_auth_session'
 
 module Roqua
@@ -9,6 +10,10 @@ module Roqua
       Sessions::OAuthSession.new(*arguments, &block)
     end
 
+    def self.token_session(*arguments, &block)
+      Sessions::TokenSession.new(*arguments, &block)
+    end
+
     def self.basic_auth_session(*arguments, &block)
       Sessions::BasicAuthSession.new(*arguments, &block)
     end

data/lib/roqua/core_api/sessions/auth_session.rb

@@ -59,7 +59,7 @@ module Roqua
           when 401
             access_denied(response)
           else
-            fail response.parsed_response || 'error'
+            fail(response.parsed_response.to_s || 'error')
           end
         end
 

data/lib/roqua/core_api/sessions/token_session.rb

@@ -0,0 +1,38 @@
+module Roqua
+  module CoreApi
+    module Sessions
+      class TokenSession < AuthSession
+        attr_reader :access_token
+
+        def initialize(access_token:, **additional_arguments)
+          @access_token = access_token
+          super additional_arguments
+        end
+
+        def logout
+          delete 'sessions/destroy'
+        end
+
+        # ping the server to check if session is still valid.
+        # Will throw NoSession as usual if not.
+        def ping
+          get "/ping"
+        end
+
+        private
+
+        def access_denied(response)
+          if response['no_session']
+            fail NoSession
+          else
+            fail Unauthorized
+          end
+        end
+
+        def headers
+          {"Authorization" => "Session #{access_token}"}
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module CoreApi
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/fabricators/auth_session_fabricator.rb

@@ -1,3 +1,9 @@
 Fabricator(:roqua_core_api_auth_session, from: Roqua::CoreApi::Sessions::AuthSession) do
   initialize_with { Roqua::CoreApi::Sessions::AuthSession.new core_site: 'http://core.dev' }
 end
+
+Fabricator(:roqua_core_api_token_session, from: Roqua::CoreApi::Sessions::TokenSession) do
+  initialize_with do
+    Roqua::CoreApi::Sessions::TokenSession.new access_token: 'some_access_token', core_site: 'http://core.dev'
+  end
+end

data/spec/lib/roqua/core_api/models/active_virtus_spec.rb

@@ -42,7 +42,7 @@ module Roqua
           it 'can be set by datetime(i1) params' do
             subject.attributes = { 'datetime(1i)' => '1999', 'datetime(2i)' => '12', 'datetime(3i)' => '8',
                                    'datetime(4i)' => '22', 'datetime(5i)' => '23', 'datetime(6i)' => '24'}
-            expect(subject.datetime).to eq DateTime.new(1999, 12, 8, 22, 23, 24)
+            expect(subject.datetime).to eq DateTime.new(1999, 12, 8, 22, 23, 24).utc
           end
         end
       end

data/spec/lib/roqua/core_api/sessions/token_session_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+describe TokenSession do
+  let(:session) { Fabricate :roqua_core_api_token_session }
+  let(:response) { double('response', code: 201, parsed_response: 'some_response') }
+
+  describe '#initialize' do
+    it 'sets the access_token instance variable' do
+      session = Roqua::CoreApi.token_session access_token: 'some_access_token'
+      expect(session.access_token).to eq('some_access_token')
+    end
+
+    it 'allows to override the core_site variable' do
+      session = Roqua::CoreApi.token_session access_token: 'some_access_token', core_site: 'some_core_site'
+      expect(session.core_site).to eq('some_core_site')
+    end
+
+    it 'defaults the AuthSession core_site CORE_SITE env variable default value' do
+      original_env_core_site = ENV['CORE_SITE']
+      ENV['CORE_SITE'] = 'some_env_core_site'
+      session = Roqua::CoreApi.token_session access_token: 'some_access_token'
+      ENV['CORE_SITE'] = original_env_core_site
+      expect(session.core_site).to eq('some_env_core_site')
+    end
+  end
+
+  describe '#logout' do
+    it 'sends a put request to the session#destroy' do
+      expect(HTTParty).to receive(:delete).with("http://core.dev/api/v1sessions/destroy.json",
+                                                headers: {"Authorization" => "Session some_access_token"},
+                                                query: {},
+                                                basic_auth: nil,
+                                                timeout: nil).and_return(response)
+      session.logout
+    end
+  end
+
+  describe 'headers' do
+    it 'sets the Authorization header' do
+      expect(HTTParty).to receive(:get).with(an_instance_of(String),
+                                             headers: {"Authorization" => "Session some_access_token"},
+                                             query: {},
+                                             basic_auth: nil,
+                                             timeout: nil).and_return(response)
+      session.get 'some_path'
+    end
+  end
+
+  describe '#access_denied' do
+    it 'raises a no_session error when response is 401 with a no_session response' do
+      stub_request(:get, 'http://core.dev/api/v1/some_path.json?').to_return(
+        status: 401,
+        body: '{ "no_session": true }',
+        headers: { 'Content-Type' => 'application/json' })
+      expect { session.get '/some_path' }.to raise_error(NoSession)
+    end
+
+    it 'raises a unauthorized error when response is 401 without a no_session response' do
+      stub_request(:get, 'http://core.dev/api/v1/some_path.json?').to_return(
+        status: 401,
+        body: '',
+        headers: { 'Content-Type' => 'application/json' })
+      expect { session.get '/some_path' }.to raise_error(Unauthorized)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-core-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -182,7 +182,7 @@ files:
 - Rakefile
 - config/locales/validation_errors.yml
 - core_api.gemspec
-- lib/i18n/i18n.rb
+- lib/i18n/core_api_i18n.rb
 - lib/roqua-core-api.rb
 - lib/roqua/core_api.rb
 - lib/roqua/core_api/base.rb
@@ -190,7 +190,9 @@ files:
 - lib/roqua/core_api/create_dossier_group.rb
 - lib/roqua/core_api/create_dossier_group_export_synchronously.rb
 - lib/roqua/core_api/create_professional.rb
+- lib/roqua/core_api/create_token_session.rb
 - lib/roqua/core_api/delete_dossier_group_right.rb
+- lib/roqua/core_api/destroy_token_session.rb
 - lib/roqua/core_api/dossier_groups.rb
 - lib/roqua/core_api/dossiers.rb
 - lib/roqua/core_api/list_dossier_group_rights.rb
@@ -208,6 +210,7 @@ files:
 - lib/roqua/core_api/sessions/auth_session.rb
 - lib/roqua/core_api/sessions/basic_auth_session.rb
 - lib/roqua/core_api/sessions/oauth_session.rb
+- lib/roqua/core_api/sessions/token_session.rb
 - lib/roqua/core_api/update_dossier.rb
 - lib/roqua/core_api/update_person.rb
 - lib/roqua/core_api/version.rb
@@ -230,6 +233,7 @@ files:
 - spec/lib/roqua/core_api/sessions/auth_session_spec.rb
 - spec/lib/roqua/core_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/core_api/sessions/oauth_session_spec.rb
+- spec/lib/roqua/core_api/sessions/token_session_spec.rb
 - spec/lib/roqua/core_api/update_dossier_spec.rb
 - spec/spec_helper.rb
 - spec/support/httpparty_helpers.rb
@@ -253,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around Core's API
@@ -275,6 +279,7 @@ test_files:
 - spec/lib/roqua/core_api/sessions/auth_session_spec.rb
 - spec/lib/roqua/core_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/core_api/sessions/oauth_session_spec.rb
+- spec/lib/roqua/core_api/sessions/token_session_spec.rb
 - spec/lib/roqua/core_api/update_dossier_spec.rb
 - spec/spec_helper.rb
 - spec/support/httpparty_helpers.rb