naranya_ecm-sdk 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0353edc6355ebb93ca61dd4a7588a4b9336b1aae
-  data.tar.gz: 75bec65cbe42fcf342f2c8f3309ccfc541cd4f03
+  metadata.gz: fe024c1fb8de7856dc1c7fc5890f5194046059b8
+  data.tar.gz: eae615e6dc5b250134ac204e936a7509b019f4d1
 SHA512:
-  metadata.gz: 2da8dc194f9c5ecdb04208f9586008f2f4ae1760928504734580e6778fa097f21604ff8b858527a1dcf8fbd3c27c407f19b5085e531394b6710cbad5116996a2
-  data.tar.gz: ad1142153cb12539dd5b1a4f1cb98fd57c7a670943e16fdcaa5f989e779045f3e298dbff08100b0df80ba79ffb8c1b47945225d76b468de3b77fb65b7f3c8263
+  metadata.gz: 6e1ed60fa76e8b03a7f20e2a4c7995b16e147d234ca671c93319ae62ccfa740920238f7baa17f387fbfcac35b9be253b44d34ed772b912013d69e9bee3b2d177
+  data.tar.gz: dcf357e123ab07edd39cc5adf3df13ffbb36416d2bc45076e83593775781ec7bffd1182ffcd64d3103a4c45d50aad6ea6abbbe952397dd35fdc171fed8c4748e

data/lib/naranya_ecm-sdk.rb

@@ -17,6 +17,10 @@ module NaranyaEcm
     autoload :Client
   end
 
+  # == NaranyaEcm \Rest Module
+  #
+  # <tt>NaranyaEcm::Rest</tt> provides the REST persistance and querying layer
+  # that connects the NaranyaEcm models with the Naranya CaaS REST services.
   module Rest
     extend ActiveSupport::Autoload
     autoload :Client
@@ -47,6 +51,9 @@ module NaranyaEcm
     autoload :ContentLifecycle
   end
 
+  # == NaranyaEcm \Search Module
+  #
+  # <tt>NaranyaEcm::Search</tt> implements classes and methods for querying the Naranya CaaS Search engine.
   module Search
     extend ActiveSupport::Autoload
     autoload :Hit

data/lib/naranya_ecm-sdk/version.rb

@@ -1,3 +1,3 @@
 module NaranyaEcm
-  VERSION = "0.0.27"
+  VERSION = "0.0.28"
 end

data/lib/naranya_ecm/models/content.rb

@@ -1,84 +1,241 @@
-
 module NaranyaEcm
+
+  ##
+  # Represents a Content unit in the Naranya CaaS Service
+  #
+  # A content unit is made of by a list of some required attributes,
+  # along with any non-required attributes.
+  #
+  # == Attributes List
+  #
+  # === Required Attributes
+  #
+  # In order to create a Content Unit, the Content Object should contain at least the following attributes:
+  # * <tt>lifecycle_name:</tt> Indicates whether the Content object follows a <tt>simple</tt> lifecycle, a <tt>validatable</tt> lifecycle (can't publish without some sort of editorial validation first), or any other significant lifecycle.
+  # * <tt>title_translations:</tt> At least one localized title is required. This attribute is a Hash-like object, requiring the locale name as a key, and the localized string as value. 
+  # * <tt>author:</tt> This string represents the name of the author of the content.
+  #
+  # === Other significant attributes
+  #
+  # The Naranya CaaS Service is prepared to manage and gives meaning to the following attributes:
+  # * <tt>type:</tt> The type of content. Aids the client application in determining how to display and manage the content.
+  # * <tt>description_translations:</tt> Localizable descriptions of the Content.
+  # * <tt>content_rating:</tt>
+  # * <tt>keywords:</tt> Array containing a list of keywords
+  # * <tt>main_url:</tt> The main URL pointing to the content AS DISPLAYED BY THE CLIENT APP.
+  #
+  # == Associations
+  #
+  # * <tt>category:</tt>
+  # * <tt>versions:</tt>
+  # * <tt>current_version:</tt>
+  # * <tt>latest_version:</tt>
+  # * <tt>media_resources:</tt>
   class Content
 
+    # Include the REST persistance methods:
     include NaranyaEcm.document_module
+
+    # Include the timestamping methods:
     include NaranyaEcm::Behaviors::Timestampable
+
+    # Include the search methods:
     include NaranyaEcm::Search::Methods
+
+    # Include the media list methods:
     include NaranyaEcm::Behaviors::MediaMethods
 
-    # Type:
+    ##
+    # :attr: type
+    #
     # Describes the main type of the content - App, Note, etc.
     field :type, type: String
 
-    # Content Lifecycle Name:
+    ##
+    # :attr: lifecycle_name
+    #
     # Determines the lifecycle for the specific content:
-    # - simple:       draft -> published -> inactive
-    # - validatable:  draft -> awaiting_validation -> validated -> published -> inactive
-    # - expirable:    draft -> published -> expired/inactive
+    # * <tt>simple:</tt>       draft -> published -> deactivated
+    # * <tt>validatable:</tt>  draft -> awaiting_acceptance -> accepted -> published -> deactivated
+    # * <tt>expirable:</tt>    draft -> published -> expired/inactive
     field :lifecycle_name, type: String, default: -> { 'simple' }
     validates :lifecycle_name, presence: true
 
-    # Content Lifecycle State:
+    ##
+    # :attr: lifecycle_state
+    #
     # A managed string that describes the current state of this particular content.
     # Depending on the Content's lifecycle, it changes upon several events.
-    # - draft:
-    # - awaiting_validation:
-    # - validated:
-    # - invalidated:
-    # - published:
+    # * <tt>draft:</tt>
+    # * <tt>awaiting_acceptance:</tt>
+    # * <tt>accepted:</tt>
+    # * <tt>rejected:</tt>
+    # * <tt>published:</tt>
+    # * <tt>deactivated:</tt>
     field :lifecycle_state, type: String, default: -> { :draft }
     validates :lifecycle_state, presence: true
 
-    # Title (Localized):
+    ##
+    # :attr: title
+    #
     # The content title that can be displayed as header, result, etc.
     field :title, type: String, localize: true
     validate :at_least_one_title_translation_must_exist
 
-    # Description (Localized):
-    # The content title that can be displayed as header, result, etc.
+    ##
+    # :attr: title_translations
+    #
+    # Hash-like containing all the title translations.
+
+    ##
+    # :attr: description
+    #
+    # The localized content description that can be displayed as header, result, etc.
     field :description, type: String, localize: true
+
+    ##
+    # :attr: description_translations
+    #
+    # Hash-like containing all the description translations.
     
-    # Content Rating:
+    ##
+    # :attr: content_rating
+    #
+    # Hash-like object containing all the localized content ratings, with the rating system as a Key, and the corresponding ratin object as value.
     field :content_rating, type: Hash
 
-    # Keywords:
+    ##
+    # :attr: keywords
+    #
+    # Array containing a list of keywords
     field :keywords, type: Array
 
+    ##
+    # :attr: author
+    #
     # Author:
     # The name of the user who created this content.
     field :author, type: String
-    validates :author,
-      presence: true
+    validates :author, presence: true
 
+    ##
+    # :attr: main_url
+    #
     # Main URL:
     # The URL that should be used to render or display the content.
     field :main_url, type: String
-    validates :main_url,
-      format: { with: URI.regexp },
-      allow_nil: true,
-      allow_blank: true
+    validates :main_url, format: { with: URI.regexp }, allow_nil: true, allow_blank: true
 
+    ##
+    # :attr: category
+    # :category: Associations
+    #
+    # The category to which the Content belongs.
     belongs_to :category
 
-    has_many :versions,
-        class_name: :ContentVersion
+    ##
+    # :attr: versions
+    # :category: Associations
+    #
+    # A list of ContentVersion objects corresponding to changes in a versionable content.
+    has_many :versions, class_name: :ContentVersion
     
-    belongs_to :current_version,
-        class_name: :ContentVersion
+    ##
+    # :attr: current_version
+    # :category: Associations
+    #
+    # The ContentVersion object marked as current. It must be published.
+    belongs_to :current_version, class_name: :ContentVersion
 
-    belongs_to :latest_version,
-        class_name: :ContentVersion
+    ##
+    # :attr: latest_version
+    # :category: Associations
+    #
+    # The ContentVersion object marked as latest.
+    belongs_to :latest_version, class_name: :ContentVersion
 
-    has_many :media_resources,
-        class_name: :MediaResource,
-        inverse_of: :content
+    ##
+    # :attr: media_resources
+    # :category: Associations
+    #
+    # A list of MediaResource objects associated directly to the Content.
+    has_many :media_resources, class_name: :MediaResource, inverse_of: :content
     
     ###############################################################
     # StateMachine:
     include AASM
     include AASM::Persistence::RestPersistence
 
+    ##
+    # :method: request_an_acceptance_review
+    # :call-seq:
+    #   request_an_acceptance_review => true or false
+    #
+    # Triggers the <tt>request_an_acceptance_review</tt> event, and starts the Content transition to an :awaiting_acceptance state.
+
+    ##
+    # :method: request_an_acceptance_review!
+    # :call-seq:
+    #   request_an_acceptance_review => true or Error
+    #
+    # Same as #request_an_acceptance_review, but raises an error if the transition halted.
+
+    ##
+    # :method: accept
+    # :call-seq:
+    #   accept => true or false
+    #
+    # Triggers the <tt>accept</tt> event.
+    
+    ##
+    # :method: accept!
+    # :call-seq:
+    #   accept! => true or Error
+    #
+    # Same as #accept, but raises an error if the transition halted.
+
+    ##
+    # :method: reject
+    # :call-seq:
+    #   reject => true or false
+    #
+    # Triggers the <tt>reject</tt> event, which starts the Content transition to an <tt>:rejected</tt> state.
+    
+    ##
+    # :method: reject!
+    # :call-seq:
+    #   reject! => true or Error
+    #
+    # Same as #reject, but raises an error if the transition did not complete.
+
+    ##
+    # :method: publish
+    # :call-seq:
+    #   publish => true or false
+    #
+    # Triggers the <tt>publish</tt> event, which starts the Content transition to a <tt>:published</tt> state.
+    
+    ##
+    # :method: publish!
+    # :call-seq:
+    #   publish! => true or Error
+    #
+    # Same as #publish, but raises an error if the transition did not complete.
+
+    ##
+    # :method: deactivate
+    # :call-seq:
+    #   deactivate => true or false
+    #
+    # Triggers the <tt>deactivate</tt> event, which starts the Content transition to a <tt>:deactivated</tt> state.
+    
+    ##
+    # :method: deactivate!
+    # :call-seq:
+    #   deactivate! => true or Error
+    #
+    # Same as #deactivate, but raises an error if the transition did not complete.
+
     aasm column: :lifecycle_state do
 
       state :draft, initial: true
@@ -119,11 +276,29 @@ module NaranyaEcm
       end
     end
 
-    def simple_lifecycle?; self.lifecycle_name == 'simple'; end
-    def validatable_lifecycle?; self.lifecycle_name == 'validatable'; end
+    ##
+    # :method: simple_lifecycle?
+    # :call-seq:
+    #   simple_lifecycle? => true or false
+    #
+    # Shows whether the Content object has a simple lifecycle.
+    def simple_lifecycle?
+      self.lifecycle_name == 'simple'
+    end
+    
+    ##
+    # :method: validatable_lifecycle?
+    # :call-seq:
+    #   validatable_lifecycle? => true or false
+    #
+    # Shows whether the Content object has a validatable lifecycle.
+    def validatable_lifecycle?
+      self.lifecycle_name == 'validatable'
+    end
 
     private
 
+      # Validates that at least one title translation exists.
       def at_least_one_title_translation_must_exist
         errors.add :title_translations, "must have at least one translation" unless title_translations.keys.any?
       end

data/lib/naranya_ecm/rest/client.rb

@@ -74,7 +74,7 @@ module NaranyaEcm::Rest
               log_level: :debug,
               log_format: :curl
 
-            ::NaranyaEcm::Rest::RestError.raise_by_code(token_response.code) unless token_response.success?
+            ::NaranyaEcm::Rest::RestError.raise_by_failed_response(token_response.code) unless token_response.success?
             
             "Bearer #{token_response['access_token']}"
           end

data/lib/naranya_ecm/rest/errors.rb

@@ -11,6 +11,8 @@ module NaranyaEcm::Rest
       super(msg)
     end
 
+    ##
+    # Captura un response y genera + avienta una excepción.
     def self.raise_by_failed_response(response, message = "")
       klass = case response.code
       when 401 then AuthorizationRequired
@@ -54,22 +56,32 @@ module NaranyaEcm::Rest
 
   # Raised when connection to the database could not been established (for example when <tt>connection=</tt>
   # is given a nil object).
-  class ConnectionNotEstablished < RestError; end
+  class ConnectionNotEstablished < RestError
+  end
 
   # Raised when REST cannot find record by given id or set of ids.
-  class ResourceNotFound < RestError; end
+  class ResourceNotFound < RestError
+  end
 
   # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
   # saved because record is invalid.
-  class ResourceNotSaved < RestError; end
+  class ResourceNotSaved < RestError
+  end
 
   # Raised by ActiveRecord::Base.destroy! when a call to destroy would return false.
-  class ResourceNotDestroyed < RestError; end
+  class ResourceNotDestroyed < RestError
+  end
+
+  class AuthorizationRequired < RestError
+  end
 
-  class AuthorizationRequired < RestError; end
+  class Forbidden < RestError
+  end
 
-  class Forbidden < RestError; end
-  class UnprocessableEntity < RestError; end
-  class RemoteFailed < RestError; end
+  class UnprocessableEntity < RestError
+  end
+
+  class RemoteFailed < RestError
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naranya_ecm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport