astroboa-rb 0.4.0

data/lib/astroboa-rb/clienterror.rb

@@ -0,0 +1,41 @@
+# This is the base AstroboaClient exception class. 
+# For your convenience you do not need to write rescue code for each astroboa client api call. 
+# If an error occurs the exception is not directly raised but rather it is passed to 
+# either an exception hadling error block that you may provide in each api call
+# or otherwise to the generic error callback that you have specified by means of the "on_error" method 
+# if you provide no error handling block and no generic error callback is set then a non successful api call returns nil as a response
+# All succeful api calls return non nil responses so a quick and easy way to check the success of the call without writing error
+# handling blocks is to check for a non nil response. 
+# You can get the status code of the api call (i.e the corresponding http code) by e.api_code. 
+# if any response related to the error has been returned, you may see the response by e.api_response
+# A message related to the error is available at e.message
+# Use e.inspet or e.to_s to get the error message as well as the api response
+
+module Astroboa
+  
+  class ClientError < RuntimeError
+  
+    attr_accessor :api_response, :api_code
+    attr_writer :message
+
+    def initialize message = nil, api_code = nil, api_response = nil  
+      @message = message
+      @api_code = api_code
+      @api_response = api_response
+    end
+
+    def inspect
+      "#{message}: #{api_response}"
+    end
+
+    def to_s
+      inspect
+    end
+
+    def message
+      @message || self.class.name
+    end
+
+  end
+
+end

data/lib/astroboa-rb/version.rb

@@ -0,0 +1,3 @@
+module Astroboa
+  VERSION = "0.4.0"
+end

data/test/features/astroboaClient.feature

@@ -0,0 +1,46 @@
+Feature: Astroboa Ruby Client
+	Develop an astroboa ruby client that enables ruby developers 
+	to easily read, write and search astroboa resources from ruby programs. 
+	The client eliminates the need to execute raw http calls
+	to the astroboa REST API and hides the REST API details.
+	
+	Background:
+	    Given the following text resources persisted to astroboa
+	    | contentObjectTypeName        | profile.title               | body                           |
+	    | genericContentResourceObject | Test Resource 1             | Hello World 1                  |
+	    | genericContentResourceObject | Test Resource 2             | Hello World 2                  |
+	    | genericContentResourceObject | Test Resource to be updated | This text will be updated soon |
+
+	
+	Scenario: Create a new text resource (contentObjectTypeName="genericContentResourceObject") with title "Test Resource" and body "Hello World"
+		Given a text resource (stored in hash "my_new_text_resource") with title "Test Resource" and body "Hello World" has already been persisted to astroboa
+		Then an id has been assigned to it
+			And the new resource id is returned by the call  
+		
+	Scenario: Read as hash an existing text resource using its id as identifier
+		Given a text resource (stored in hash "my_new_text_resource") with title "Test Resource 2" and body "Hello World again" has already been persisted to astroboa
+			And the id of the persisted resource is stored in variable "id_of_resource_to_read"
+		When method getObject(id_of_resource_to_read) is called
+		Then a hash object with the resource is returned 
+		
+	Scenario: Read as object an existing text resource using its id as identifier
+		Given a text resource (stored in hash "my_new_text_resource") with title "Test Resource 2" and body "Hello World again" has already been persisted to astroboa
+			And the id of the persisted resource is stored in variable "id_of_resource_to_read"
+		When method getObject(id_of_resource_to_read, nil, :object) is called
+			Then an Openstruct object with the resource is returned
+	
+	Scenario: Update the body text of an existing text resource
+		Given a text resource (stored in hash "my_new_text_resource") with title "Test Resource to be updated" and body "This text will be updated soon" has already been persisted to astroboa
+			And the id of the persisted resource is stored in variable "id_of_resource_to_update"
+		When method updateObject({"contentObjectTypeName" => "genericContentResourceObject", "cmsIdentifier" => id_of_resource_to_update, "body" => "Updated Body Text"}) is called
+		Then the body text of the persisted text resource is "Updated Body Text"
+		
+	Scenario: Get a collection of all text resources that their body contains the word hello
+		Given a text resource (stored in hash "my_new_text_resource") with title "Hello is contained in body text" and body "The word hello is contained in this text" has already been persisted to astroboa
+			And the id of the persisted resource is stored in variable "id_of_resource"
+		When method getObjectCollection('contentTypeName="genericContentResourceObject" AND body CONTAINS "Hello"') is called
+		Then the persisted resource is contained in the resource collection we get back
+		
+	Scenario: Get all object types modeled in the repository
+		When method getModel is called and the argument "objectTypeOrProperty" is absent or equal to the empty string 
+		Then a hash with all object types modeled in the repository is returned and the hash contains the core object type "fileResourceObject" 

data/test/features/step_definitions/astroboaClientSteps.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+#begin require 'rspec/expectations'; rescue LoadError; require 'spec/expectations'; end
+require 'rspec/expectations'
+require 'cucumber/formatter/unicode'
+$:.unshift(File.dirname(__FILE__) + '/../../../lib')
+require 'astroboa-rb'
+
+Before do
+  @astroboaClient = Astroboa::Client.new('localhost:8080', 'altcine', 'SYSTEM', 'altcine2010')
+  @astroboaClient.on_error do |exception|
+    puts exception.message
+  end
+end
+
+After do
+end
+
+Given /^the following text resources persisted to astroboa$/ do |table|
+  # table is a Cucumber::Ast::Table
+end
+
+
+# CREATE A NEW TEXT RESOURCE (ASTROBOA OBJECT OF TYPE genericContentResourceObject)
+Given /^a text resource \(stored in hash "my_new_text_resource"\) with title "([^"]*)" and body "([^"]*)" has already been persisted to astroboa$/ do |title, body|
+  step "a hash object named \"my_new_text_resource\" is created that holds the text resource property values, i\.e\. title=\"#{title}\" and body=\"#{body}\""
+  step "method createObject(my_new_text_resource) is called"
+end
+
+When /^a hash object named "my_new_text_resource" is created that holds the text resource property values, i\.e\. title="([^"]*)" and body="([^"]*)"$/ do |title, body|
+  @my_new_text_resource = {"contentObjectTypeName" => "genericContentResourceObject", "profile" => {"title" => title}, "body" => body}
+  puts "this is the resource hash before it is persisted: #{@my_new_text_resource}"
+end
+
+
+
+
+# CREATE ASTROBOA OBJECT FROM RUBY HASH
+When /^method createObject\(my_new_text_resource\) is called$/ do
+  @my_new_text_resource_id = @astroboaClient.createObject @my_new_text_resource
+end
+
+Then /^an id has been assigned to it$/ do
+    @my_new_text_resource['cmsIdentifier'].should_not eq(nil)
+    puts "this is the resource hash after it is persisted: #{@my_new_text_resource}" 
+end
+
+Then /^the new resource id is returned by the call$/ do
+    @my_new_text_resource_id.should_not eq(nil)
+    puts "the call has returned: #{@my_new_text_resource_id}" 
+end
+
+Given /^the id of the persisted resource is stored in variable "([^"]*)"$/ do |id_of_resource|
+  self.instance_variable_set("@#{id_of_resource}", @my_new_text_resource_id)
+  id = self.instance_variable_get("@#{id_of_resource}")
+  puts "The id is: #{id}"
+end
+
+
+
+
+# READ ASTROBOA OBJECT AS RUBY HASH
+When /^method getObject\(id_of_resource_to_read\) is called$/ do
+  @retrieved_text_resource = @astroboaClient.getObject @id_of_resource_to_read 
+end
+
+Then /^a hash object with the resource is returned$/ do
+  @retrieved_text_resource.should_not eq(nil)
+  @retrieved_text_resource['cmsIdentifier'].should eq(@id_of_resource_to_read)
+  puts "The retrieved resource is: #{@retrieved_text_resource}"
+end
+
+
+
+
+
+# READ ASTROBOA OBJECT AS RUBY OBJECT
+When /^method getObject\(id_of_resource_to_read, nil, :object\) is called$/ do
+  @retrieved_text_resource = @astroboaClient.getObject(@id_of_resource_to_read, nil, :object)  
+end
+
+Then /^an Openstruct object with the resource is returned$/ do
+  @retrieved_text_resource.should_not eq(nil)
+  @retrieved_text_resource.cmsIdentifier.should eq(@id_of_resource_to_read)
+  @retrieved_text_resource.profile.title.should eq('Test Resource 2')
+  puts "The retrieved resource is: #{@retrieved_text_resource}"
+end
+
+#Given /^the id of the persisted resource is stored in variable "id_of_resource_to_update"$/ do
+#  @id_of_resource_to_update = @my_new_text_resource_id
+#  puts "The id is: #{@id_of_resource_to_update}"
+#end
+
+# UPDATE EXISTING ASTROBOA OBJECT
+When /^method updateObject\(([^\)]*)\) is called$/ do |resource_hash_string|
+  resource = {"contentObjectTypeName" => "genericContentResourceObject", "cmsIdentifier" => @id_of_resource_to_update, "body" => "Updated Body Text"}
+  response = @astroboaClient.updateObject resource
+  response.should_not eq(nil)
+  puts "response is: #{response}"
+end
+
+Then /^the body text of the persisted text resource is "([^"]*)"$/ do |body_text|
+  text_resource = @astroboaClient.getObject @id_of_resource_to_update
+  text_resource['body'].should eq(body_text)
+end
+
+
+
+# GET A COLLECTION OF OBJECTS (i.e. search in astroboa with criteria and get back a collection of objects that meet the criteria) 
+When /^method getObjectCollection\('objectType="genericContentResourceObject" AND body CONTAINS "Hello"'\) is called$/ do
+  query = 'objectType="genericContentResourceObject" AND body CONTAINS "Hello"'
+  @resource_collection = @astroboaClient.getObjectCollection(query)
+  @resource_collection.should_not eq(nil)
+end
+
+
+Then /^the persisted resource is contained in the resource collection we get back$/ do
+  text_resources = @resource_collection['resourceCollection']['resource']
+  found_id = nil
+  puts "Looking for resource #{@id_of_resource}"
+  text_resources.each do |text_resource|
+    puts text_resource['cmsIdentifier']
+    if text_resource['cmsIdentifier'] == @id_of_resource
+      found_id = text_resource['cmsIdentifier']
+      break
+    end 
+  end
+  puts found_id
+  found_id.should_not eq(nil)
+end
+
+
+# READ ALL MODELED OBJECT TYPES (i.e. if no object type or property is specified when callint the getModel method then all object types are returned)
+When /^method getModel is called and the argument "objectTypeOrProperty" is absent or equal to the empty string$/ do
+  @resource_type_collection = @astroboaClient.getModel
+  @resource_type_collection.should_not eq(nil)
+end
+
+Then /^a hash with all object types modeled in the repository is returned and the hash contains the core object type "([^"]*)"$/ do |expected_object_type|
+  object_types = @resource_type_collection['arrayOfObjectTypes']['objectType']
+  found_type = nil
+  object_types.each do |object_type|
+    if object_type['name'] == expected_object_type
+      found_type = object_type['name']
+      break
+    end 
+  end
+  found_type.should_not eq(nil)
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: astroboa-rb
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- BetaCONCEPT
+- Gregory Chomatas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Provides easy access to the REST-based 'Astroboa Resource API'. With
+  just a few lines of code you can read, write and search semi-structured content
+  to any astroboa repository hosted in any server in the world.
+email:
+- support@betaconcept.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.rdoc
+- COPYING
+- COPYING.LESSER
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- astroboa-rb.gemspec
+- lib/astroboa-rb.rb
+- lib/astroboa-rb/client.rb
+- lib/astroboa-rb/clienterror.rb
+- lib/astroboa-rb/version.rb
+- test/features/astroboaClient.feature
+- test/features/step_definitions/astroboaClientSteps.rb
+homepage: http://www.astroboa.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: astroboa-rb
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Astroboa Client for Ruby.
+test_files:
+- test/features/astroboaClient.feature
+- test/features/step_definitions/astroboaClientSteps.rb