supplejack_client 1.0.5 → 1.0.7

data/lib/supplejack/story_item.rb

@@ -0,0 +1,149 @@
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
+
+module Supplejack
+
+  # The +StoryItem+ class represents a StoryItem on the Supplejack API
+  #
+  # A StoryItem always belongs to a Story. represents.
+  #
+  # A StoryItem object has the following values:
+  # - id
+  # - type
+  # - sub_type
+  # - position
+  # - meta [Hash]
+  # - content [Hash]
+  class StoryItem
+    include Supplejack::Request
+
+    MODIFIABLE_ATTRIBUTES = [:position, :meta, :content, :type, :sub_type].freeze
+    UNMODIFIABLE_ATTRIBUTES = [:id, :story_id].freeze
+    ATTRIBUTES = (MODIFIABLE_ATTRIBUTES + UNMODIFIABLE_ATTRIBUTES).freeze
+
+    attr_accessor *ATTRIBUTES
+    attr_accessor :errors
+    attr_reader :api_key
+
+    def initialize(attributes={})
+      @attributes = attributes.try(:deep_symbolize_keys) || {}
+      @api_key = @attributes[:api_key]
+
+      self.meta ||= {}
+      self.attributes = @attributes
+    end
+
+    # Assigns the provided attributes to the StoryItem object
+    #
+    def attributes=(attributes)
+      attributes = attributes.try(:deep_symbolize_keys) || {}
+
+      attributes.each do |attr, value|
+        self.send("#{attr}=", value) if ATTRIBUTES.include?(attr)
+      end
+    end
+
+    def attributes
+      retrieve_attributes(ATTRIBUTES)
+    end
+
+    def api_attributes
+      retrieve_attributes(MODIFIABLE_ATTRIBUTES)
+    end
+
+    def new_record?
+      id.nil?
+    end
+
+    # Executes a POST request when the StoryItem hasn't been persisted to
+    # the API, otherwise it execute a PATCH request.
+    #
+    # When the API returns a error response, the errors are available through the Story#errors
+    # virtual attribute.
+    #
+    # @return [ true, false ] True if the API response was successful, false if not.
+    #
+    def save
+      begin
+        if self.new_record?
+          self.attributes = post(
+            "/stories/#{story_id}/items",
+            {api_key: api_key},
+            {item: self.api_attributes}
+          )
+        else
+          self.attributes = patch(
+            "/stories/#{story_id}/items/#{id}",
+            params: {api_key: api_key},
+            payload: {item: self.api_attributes}
+          )
+        end
+
+        Rails.cache.delete("/users/#{self.api_key}/stories") if Supplejack.enable_caching
+
+        true
+      rescue StandardError => e
+        self.errors = e.message
+
+        false
+      end
+    end
+
+    # Executes a DELETE request to the API with the StoryItem ID and the stories api_key
+    #
+    # When the API returns an error response, the errors are available through the StoryItem#errors
+    # virtual attribute.
+    #
+    # @return [ true, false ] True if the API response was successful, false if not.
+    #
+    def destroy
+      return false if self.new_record?
+
+      begin
+        delete("/stories/#{story_id}/items/#{id}", {api_key: api_key})
+
+        Rails.cache.delete("/users/#{api_key}/stories") if Supplejack.enable_caching
+
+        true
+      rescue StandardError => e
+        self.errors = e.message
+
+        false
+      end
+    end
+
+    # Updates the StoryItems attributes and persists it to the API
+    #
+    # @return [ true, false ] True if the API response was successful, false if not.
+    #
+    def update_attributes(attributes={})
+      self.attributes = attributes
+
+      self.save
+    end
+
+    def to_json
+      attributes.to_json
+    end
+
+    private
+
+    def retrieve_attributes(attributes_list)
+      attributes = {}
+
+      attributes_list.each do |attribute|
+        value = self.send(attribute)
+
+        attributes[attribute] = value unless value.nil?
+      end
+
+      attributes
+    end
+  end
+end

data/lib/supplejack/story_item_relation.rb

@@ -0,0 +1,81 @@
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
+
+module Supplejack
+  class StoryItemRelation
+    include Request
+
+    attr_reader :story, :errors
+
+    def initialize(story)
+      @story = story
+      items = story.attributes.try(:fetch, :contents, nil) || []
+      build_items(items)
+    end
+
+    def all
+      @items
+    end
+
+    def build(attributes = {})
+      story_item = Supplejack::StoryItem.new(attributes.merge(story_id: story.id, api_key: story.api_key))
+
+      @items << story_item
+
+      story_item
+    end
+
+    def create(attributes = {})
+      story_item = build(attributes)
+
+      story_item.save
+    end
+
+    def move_item(item_id, position)
+      begin
+        response = post("/stories/#{story.id}/items/#{item_id}/moves", {api_key: story.api_key}, {item_id: item_id, position: position})
+
+        build_items(response)
+
+        true
+      rescue StandardError => e
+        @errors = e.inspect
+
+        false
+      end
+    end
+
+    def find(id)
+      @items.detect{|i| i.id == id.to_i}
+    end
+
+    def to_json
+      all.to_json
+    end
+
+    # Any method missing on this class is delegated to the StoryItems objects array
+    # so that the developer can easily execute any Array method on the StoryItemRelation
+    #
+    # @example
+    #   story.each ....     => Iterate through the StoryItem objects array
+    #   story.size          => Get the size of the StoryItem objects array
+    #
+    def method_missing(method, *args, &block)
+      all.send(method, *args, &block)
+    end
+
+    private
+
+    def build_items(items)
+      @items = items.map do |hash|
+        Supplejack::StoryItem.new(hash.merge(story_id: story.id, api_key: story.api_key))
+      end.sort_by(&:position)
+    end
+  end
+end

data/lib/supplejack/url_formats/item_hash.rb

@@ -1,9 +1,11 @@
-# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
 # and is licensed under the GNU General Public License, version 3.
 # See https://github.com/DigitalNZ/supplejack_client for details.
 #
-# Supplejack was created by DigitalNZ at the National Library of NZ
-# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
 
 module Supplejack
   module UrlFormats

data/lib/supplejack/user.rb

@@ -1,9 +1,11 @@
-# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
 # and is licensed under the GNU General Public License, version 3.
 # See https://github.com/DigitalNZ/supplejack_client for details.
 #
-# Supplejack was created by DigitalNZ at the National Library of NZ
-# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
 
 module Supplejack
 
@@ -44,6 +46,10 @@ module Supplejack
       @sets ||= UserSetRelation.new(self)
     end
 
+    def stories
+      @stories ||= UserStoryRelation.new(self)
+    end
+
     # Initializes a UserSetRelation class which adds behaviour to build, create
     # find and order sets related to this particular User instance
     #

data/lib/supplejack/user_set.rb

@@ -1,9 +1,11 @@
-# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
 # and is licensed under the GNU General Public License, version 3.
 # See https://github.com/DigitalNZ/supplejack_client for details.
 #
-# Supplejack was created by DigitalNZ at the National Library of NZ
-# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
 
 module Supplejack
 
@@ -21,19 +23,19 @@ module Supplejack
   # - priority
   # - count
   # - tags
-  # 
+  #
   class UserSet
     extend Supplejack::Request
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
-    ATTRIBUTES = [:id, :name, :description, :privacy, :url, :priority, :count, :tags, :tag_list, 
+    ATTRIBUTES = [:id, :name, :description, :privacy, :url, :priority, :count, :tags, :tag_list,
                   :featured, :records, :created_at, :updated_at, :approved, :record]
     attr_accessor *ATTRIBUTES
     attr_accessor :api_key, :errors, :user
 
     PRIVACY_STATES = ['public', 'hidden', 'private']
-    
+
     def initialize(attributes={})
       @attributes = attributes.try(:symbolize_keys) || {}
       @user = Supplejack::User.new(@attributes[:user])
@@ -72,7 +74,7 @@ module Supplejack
     #
     def api_records
       records = self.records.is_a?(Array) ? self.records : []
-      records.map do |record_hash| 
+      records.map do |record_hash|
         record_hash = record_hash.try(:symbolize_keys) || {}
         if record_hash[:record_id]
           {record_id: record_hash[:record_id], position: record_hash[:position] }
@@ -98,7 +100,7 @@ module Supplejack
     end
 
     # Returns the api_key from the UserSet or from the User which this set belongs to.
-    # 
+    #
     def api_key
       @api_key || @user.try(:api_key)
     end
@@ -146,11 +148,11 @@ module Supplejack
     # Executes a POST request when the UserSet hasn't been persisted to the API, otherwise it executes
     # a PUT request.
     #
-    # When the API returns a error response, the errors are available through the UserSet#errors 
+    # When the API returns a error response, the errors are available through the UserSet#errors
     # virtual attribute.
     #
     # @return [ true, false ] True if the API response was successful, false if not.
-    # 
+    #
     def save
       begin
         if self.new_record?
@@ -162,7 +164,7 @@ module Supplejack
         Rails.cache.delete("/users/#{self.api_key}/sets") if Supplejack.enable_caching
         return true
       rescue StandardError => e
-        self.errors = e.inspect
+        self.errors = e.message
         return false
       end
     end
@@ -177,7 +179,7 @@ module Supplejack
     end
 
     # Assigns the provided attributes to the UserSet object
-    # 
+    #
     def attributes=(attributes)
       attributes = attributes.try(:symbolize_keys) || {}
       attributes.each do |attr, value|
@@ -188,7 +190,7 @@ module Supplejack
 
     # Define setter methods for both created_at and updated_at so that
     # they always return a Time object.
-    # 
+    #
     [:created_at, :updated_at].each do |attribute|
       define_method("#{attribute}=") do |time|
         self.instance_variable_set("@#{attribute}", Util.time(time))
@@ -223,9 +225,9 @@ module Supplejack
     end
 
     # Executes a DELETE request to the API with the UserSet ID and the user's api_key
-    # 
+    #
     # @return [ true, false ] True if the API response was successful, false if not.
-    # 
+    #
     def destroy
       if self.new_record?
         return false
@@ -235,7 +237,7 @@ module Supplejack
           Rails.cache.delete("/users/#{self.api_key}/sets") if Supplejack.enable_caching
           return true
         rescue StandardError => e
-          self.errors = e.inspect
+          self.errors = e.message
           return false
         end
       end
@@ -248,7 +250,7 @@ module Supplejack
     # Fetches the UserSet information from the API again, in case it had changed.
     # This can be useful if they items for a UserSet changed and you want the relation
     # to have the most up to date items.
-    # 
+    #
     def reload
       begin
         self.instance_variable_set("@items", nil)
@@ -264,7 +266,7 @@ module Supplejack
     # @param [ Supplejack::User ] A Supplejack::User object
     #
     # @return [ true, false ] True if the user can view the current UserSet, false if not.
-    # 
+    #
     def viewable_by?(user)
       return true if self.public? || self.hidden?
       self.owned_by?(user)
@@ -286,10 +288,10 @@ module Supplejack
     # a UserSet object with the response from the API.
     #
     # @return [ UserSet ] A UserSet object
-    # 
-    def self.find(id, api_key=nil)
+    #
+    def self.find(id, api_key=nil, params={})
       begin
-        response = get("/sets/#{id}")
+        response = get("/sets/#{id}", params)
         attributes = response["set"] || {}
         user_set = new(attributes)
         user_set.api_key = api_key if api_key.present?
@@ -308,15 +310,15 @@ module Supplejack
     # @option options [ Integer ] :per_page The per_page number to select the number of UserSet objects per page.
     #
     # @return [ Array ] A array of Supplejack::UserSet objects
-    # 
+    #
     def self.public_sets(options={})
       options.reverse_merge!(page: 1, per_page: 100)
       response = get("/sets/public", options)
       sets_array = response["sets"] || []
       user_sets = sets_array.map {|attrs| new(attrs) }
-      Supplejack::PaginatedCollection.new(user_sets, 
-                                          options[:page].to_i, 
-                                          options[:per_page].to_i, 
+      Supplejack::PaginatedCollection.new(user_sets,
+                                          options[:page].to_i,
+                                          options[:per_page].to_i,
                                           response["total"].to_i)
     end
 
@@ -345,7 +347,7 @@ module Supplejack
     # This is useful when using a Supplejack::UserSet object in the Rails provided routes helpers. Example:
     #
     #   user_set_path(@user_set)
-    # 
+    #
     def self.model_name
       ActiveModel::Name.new(self, nil, "UserSet")
     end

data/lib/supplejack/user_set_relation.rb

@@ -1,9 +1,11 @@
-# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# The Supplejack Common code is
+# Crown copyright (C) 2014, New Zealand Government,
 # and is licensed under the GNU General Public License, version 3.
 # See https://github.com/DigitalNZ/supplejack_client for details.
 #
-# Supplejack was created by DigitalNZ at the National Library of NZ
-# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+# Supplejack was created by DigitalNZ at the
+# National Library of NZ and the Department of Internal Affairs.
+# http://digitalnz.org/supplejack
 
 module Supplejack