roqua-core-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTVmMjg5NjQ3MTUwZDgzZTA3ODBkNmRkMGQ5NGY4ZmI0Y2E5Y2Y3OQ==
-  data.tar.gz: !binary |-
-    M2I5NDA5OGI4MTBlYTQ1MTEyNzc5ZmZkMmU5NzY4MmRhYzhjMmRjYw==
+SHA1:
+  metadata.gz: c2bf9efd8b13ab187adef20a4e7b69957b665a7d
+  data.tar.gz: 9c51d7e5a803c42c2f9d8844da19755b90cb5f79
 SHA512:
-  metadata.gz: !binary |-
-    NWFiNjIwYzMzZWRjN2YxMjNmNTNlYjU1YmY3M2RhMTNmOGMyM2E2ZjA4Nzg4
-    OTA4YjM2MGRiMzRjZjllOTA1MGVmMTFiNTQ3MjE2Mjg5ZmZiNGFhNTZkZGMy
-    YjA0MTdmODEyZTZlZTljY2ZlNGFlZjc2N2M1MTc0ZmQ1NWNjYzY=
-  data.tar.gz: !binary |-
-    ZDgyNGRjMmZlNzc2MTVhM2IzYTJkNjVjMmEyMjIyYjEyYjE1NzI2YjZiMmJk
-    YTQ4NDc0MWVmMWYxMDQwOWJlYTI3Mzc4YjljMTFhZWJlYmZiOTFjM2UxZjFi
-    ZTRjNjdjNzcwYjk2NzA3N2RmNTQ0YzAwYTI3NzRmOTAyODI3MWY=
+  metadata.gz: 369ad4410afc11690cdc8033de5054c61ae2532d42d3c704587c426c866db52e9a3f256e55f2aacaa838b7ee92a0a418eab7f9e1fa2ce7f8b7172b70012262f0
+  data.tar.gz: 851bc24b9f72fa41c0b23e5f95eaa4d5a0da911f0e83fe2ecb822b995d17262c52e40852dab7b731bac182476d2576cd8f7241adb560e0cbc4720289635b88ee

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.0.5 / 2014-02-10
+
+* Renamed Organization to DossierGroup
+
 ### 0.0.4 / 2014-02-03
 
 * Use object ids instead of objects in sessions

data/lib/roqua/core_api/models.rb

@@ -1,2 +1,2 @@
-require 'roqua/core_api/models/organization'
+require 'roqua/core_api/models/dossier_group'
 require 'roqua/core_api/models/dossier'

data/lib/roqua/core_api/models/{organization.rb → dossier_group.rb}

@@ -1,7 +1,7 @@
 module Roqua
   module CoreApi
     module Models
-      class Organization
+      class DossierGroup
         def initialize(attributes)
           @attributes = attributes
         end

data/lib/roqua/core_api/sessions.rb

@@ -1,4 +1,4 @@
 require 'httparty'
-require 'roqua/core_api/sessions/app_session'
 require 'roqua/core_api/sessions/organization_session'
+require 'roqua/core_api/sessions/dossier_group_session'
 require 'roqua/core_api/sessions/dossier_session'

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

@@ -0,0 +1,30 @@
+module Roqua
+  module CoreApi
+    module Sessions
+      class DossierGroupSession < OrganizationSession
+        attr_reader :dossier_group_id
+
+        def initialize(dossier_group_id, organization_id, server_url = ENV["CORE_URL"])
+          @dossier_group_id = dossier_group_id
+          super(organization_id, server_url)
+        end
+
+        def create_dossier(attributes)
+          response = post "/dossiers", dossier: attributes
+          fail response.inspect unless response.code == 201
+          Models::Dossier.new(response)
+        end
+
+        def dossier_session(dossier_id)
+          DossierSession.new dossier_id, dossier_group_id, organization_id, server_url
+        end
+
+        private
+
+        def base_url
+          super + "/dossier_groups/#{dossier_group_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,12 @@
 module Roqua
   module CoreApi
     module Sessions
-      class DossierSession < OrganizationSession
+      class DossierSession < DossierGroupSession
         attr_reader :dossier_id
 
-        def initialize(dossier_id, organization_id, app_id, server_url = ENV["CORE_URL"])
+        def initialize(dossier_id, dossier_group_id, organization_id, server_url = ENV["CORE_URL"])
           @dossier_id = dossier_id
-          super(organization_id, app_id, server_url)
+          super(dossier_group_id, organization_id, server_url)
         end
 
         def start(attributes)

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

@@ -1,28 +1,43 @@
 module Roqua
   module CoreApi
     module Sessions
-      class OrganizationSession < AppSession
+      # OrganizationSession represents a session which is scoped to a specific organization
+      # in the Core database. It deals with managing dossier groups and dossiers,
+      # but only on a anonymous base. It is not allowed to know who these dossiers
+      # represent.
+      class OrganizationSession
+        attr_reader :server_url
         attr_reader :organization_id
 
-        def initialize(organization_id, app_id, server_url = ENV["CORE_URL"])
-          @organization_id = organization_id
-          super(app_id, server_url)
+        def initialize(organization_id, server_url = ENV["CORE_URL"])
+          @server_url = server_url
+          @organization_id     = organization_id
         end
 
-        def create_dossier(attributes)
-          response = post "/dossiers", dossier: attributes
+        def create_dossier_group(attributes)
+          response = post "/dossier_groups", dossier_group: attributes
           fail response.inspect unless response.code == 201
-          Models::Dossier.new(response)
+          Models::DossierGroup.new(response)
         end
 
-        def dossier_session(dossier_id)
-          DossierSession.new dossier_id, organization_id, app_id, server_url
+        def dossier_group_session(dossier_group_id)
+          DossierGroupSession.new dossier_group_id, organization_id, server_url
         end
 
         private
 
+        def post(url, params = {})
+          # TODO: Handle authentication here
+          HTTParty.post(server_url + base_url + url + ".json", body: params)
+        end
+
+        def put(url, params = {})
+          # TODO: Handle authentication here
+          HTTParty.put(server_url + base_url + url + ".json", body: params)
+        end
+
         def base_url
-          super + "/organizations/#{organization_id}"
+          "/organizations/#{organization_id}"
         end
       end
     end

data/lib/roqua/core_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module CoreApi
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/fabricators/dossier_group_fabricator.rb

@@ -0,0 +1,3 @@
+Fabricator(:dossier_group, class_name: Roqua::CoreApi::Models::DossierGroup) do
+  initialize_with { Roqua::CoreApi::Models::DossierGroup.new 'id' => 'some_id', 'name' => 'some_name' }
+end

data/spec/fabricators/dossier_group_session_fabricator.rb

@@ -0,0 +1,5 @@
+Fabricator(:dossier_group_session, class_name: Roqua::CoreApi::Sessions::DossierGroupSession) do
+  initialize_with do
+    Roqua::CoreApi::Sessions::DossierGroupSession.new Fabricate(:dossier_group), 'some_key', 'some_server'
+  end
+end

data/spec/fabricators/organization_session_fabricator.rb

@@ -1,5 +1,3 @@
 Fabricator(:organization_session, class_name: Roqua::CoreApi::Sessions::OrganizationSession) do
-  initialize_with do
-    Roqua::CoreApi::Sessions::OrganizationSession.new Fabricate(:organization), 'some_key', 'some_server'
-  end
+  initialize_with { Roqua::CoreApi::Sessions::OrganizationSession.new 'some_key', 'some_server' }
 end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module Roqua
+  module CoreApi
+    module Sessions
+      describe DossierGroupSession do
+        let(:session) { Fabricate :dossier_group_session }
+
+        describe '#dossier_session' do
+          it 'initializes a dossier session with a given dossier_group' do
+            dossier_id = 'some_dossier_id'
+            expect(DossierSession).to receive(:new)
+                                  .with(dossier_id, session.dossier_group_id,
+                                        session.organization_id, session.server_url)
+            session.dossier_session dossier_id
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,12 +6,12 @@ module Roqua
       describe OrganizationSession do
         let(:session) { Fabricate :organization_session }
 
-        describe '#dossier_session' do
-          it 'initializes a dossier session with a given organization' do
-            dossier_id = 'some_dossier_id'
-            expect(DossierSession).to receive(:new)
-                                  .with(dossier_id, session.organization_id, session.app_id, session.server_url)
-            session.dossier_session dossier_id
+        describe '#dossier_group_session' do
+          it 'initializes an dossier_group session with a given dossier_group_id' do
+            dossier_group_id = 'some_dossier_group_id'
+            expect(DossierGroupSession).to receive(:new).with(dossier_group_id, session.organization_id,
+                                                              session.server_url)
+            session.dossier_group_session dossier_group_id
           end
         end
       end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: roqua-core-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-02-10 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: 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: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.17.1
 - !ruby/object:Gem::Dependency
   name: fabrication
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.6
 description: Provides authenticated access to Core
@@ -128,10 +128,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .yardopts
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
 - ChangeLog.md
 - Gemfile
 - Guardfile
@@ -143,18 +143,18 @@ files:
 - lib/roqua/core_api.rb
 - lib/roqua/core_api/models.rb
 - lib/roqua/core_api/models/dossier.rb
-- lib/roqua/core_api/models/organization.rb
+- lib/roqua/core_api/models/dossier_group.rb
 - lib/roqua/core_api/sessions.rb
-- lib/roqua/core_api/sessions/app_session.rb
+- lib/roqua/core_api/sessions/dossier_group_session.rb
 - lib/roqua/core_api/sessions/dossier_session.rb
 - lib/roqua/core_api/sessions/organization_session.rb
 - lib/roqua/core_api/version.rb
 - spec/core_api_spec.rb
-- spec/fabricators/app_session_fabricator.rb
 - spec/fabricators/dossier_fabricator.rb
-- spec/fabricators/organization_fabricator.rb
+- spec/fabricators/dossier_group_fabricator.rb
+- spec/fabricators/dossier_group_session_fabricator.rb
 - spec/fabricators/organization_session_fabricator.rb
-- spec/lib/roqua/core_api/sessions/app_session_spec.rb
+- spec/lib/roqua/core_api/sessions/dossier_group_session_spec.rb
 - spec/lib/roqua/core_api/sessions/organization_session_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/roqua/core/blob/master/core_api/README.markdown
@@ -167,12 +167,12 @@ 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: []
@@ -183,11 +183,11 @@ specification_version: 4
 summary: API wrapper gem around Core's API
 test_files:
 - spec/core_api_spec.rb
-- spec/fabricators/app_session_fabricator.rb
 - spec/fabricators/dossier_fabricator.rb
-- spec/fabricators/organization_fabricator.rb
+- spec/fabricators/dossier_group_fabricator.rb
+- spec/fabricators/dossier_group_session_fabricator.rb
 - spec/fabricators/organization_session_fabricator.rb
-- spec/lib/roqua/core_api/sessions/app_session_spec.rb
+- spec/lib/roqua/core_api/sessions/dossier_group_session_spec.rb
 - spec/lib/roqua/core_api/sessions/organization_session_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

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

@@ -1,45 +0,0 @@
-module Roqua
-  module CoreApi
-    module Sessions
-      # AppSession represents a session which is scoped to a specific app
-      # in the Core database. It deals with managing organizations and dossiers,
-      # but only on a anonymous base. It is not allowed to know who these dossiers
-      # represent.
-      class AppSession
-        attr_reader :server_url
-        attr_reader :app_id
-
-        def initialize(app_id, server_url = ENV["CORE_URL"])
-          @server_url = server_url
-          @app_id     = app_id
-        end
-
-        def create_organization(attributes)
-          response = post "/organizations", organization: attributes
-          fail response.inspect unless response.code == 201
-          Models::Organization.new(response)
-        end
-
-        def organization_session(organization_id)
-          OrganizationSession.new organization_id, app_id, server_url
-        end
-
-        private
-
-        def post(url, params = {})
-          # TODO: Handle authentication here
-          HTTParty.post(server_url + base_url + url + ".json", body: params)
-        end
-
-        def put(url, params = {})
-          # TODO: Handle authentication here
-          HTTParty.put(server_url + base_url + url + ".json", body: params)
-        end
-
-        def base_url
-          "/apps/#{app_id}"
-        end
-      end
-    end
-  end
-end

data/spec/fabricators/app_session_fabricator.rb

@@ -1,3 +0,0 @@
-Fabricator(:app_session, class_name: Roqua::CoreApi::Sessions::AppSession) do
-  initialize_with { Roqua::CoreApi::Sessions::AppSession.new 'some_key', 'some_server' }
-end

data/spec/fabricators/organization_fabricator.rb

@@ -1,3 +0,0 @@
-Fabricator(:organization, class_name: Roqua::CoreApi::Models::Organization) do
-  initialize_with { Roqua::CoreApi::Models::Organization.new 'id' => 'some_id', 'name' => 'some_name' }
-end

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

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-module Roqua
-  module CoreApi
-    module Sessions
-      describe AppSession do
-        let(:session) { Fabricate :app_session }
-
-        describe '#organization_session' do
-          it 'initializes an organization session with a given organization_id' do
-            organization_id = 'some_organization_id'
-            expect(OrganizationSession).to receive(:new).with(organization_id, session.app_id, session.server_url)
-            session.organization_session organization_id
-          end
-        end
-      end
-    end
-  end
-end