supplejack_client 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4dab73234e69432fb7307710644e9334d8390d5
-  data.tar.gz: 8e7a12fc595c18b2effeaecc3c7f1dbabc39f886
+  metadata.gz: 607c91386fe82d2b35fc9e1afdaa111f931c5689
+  data.tar.gz: 9ed5ba9435d54de0192afd8760f2e60f30b57e54
 SHA512:
-  metadata.gz: 07fdb8b8380510afd16e72e7833f031323e9986ebc6690a643e239b55c2106637d21eafa1f1a032ad32fa901485704eeda8b1685d65abb9007fcc77c76052a7a
-  data.tar.gz: 5a36fb4d103c64dab9127e2942c1dcc3e04db2d58432d72a00f40e2cdc88d5b0aacd6a761be84a3224abc059660a3879f1cca3e9995d645652cd2a34e847f821
+  metadata.gz: 138a2ed70f1791ebf0759347558a21b0f008c890ee4f417c2c62968e055521be90fc58f1121bef8cd3399a606e6d3971d79d6e406611a1d35d8a9ef467c8e9ee
+  data.tar.gz: 86b874fbfeb3fcf178ec8c3d345405ba970d028dd028d193a913218ccc017d746814e3578500cada6140274229176d721ecb28e0d449049614fd62f55dbba2ee

data/.gitignore

@@ -22,6 +22,6 @@ tmp
 .rvmrc
 
 #RBENV CONFIG
-.rbenv-version
+# .rbenv-version
 supplejack_client.sublime-project
-supplejack_client.sublime-workspace
+supplejack_client.sublime-workspace

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-- 1.9.3
-- 2.1.2
+- 2.1.9
+- 2.3.1
 cache: bundler
 bundler_args: --without production
 sudo: false

data/Gemfile

@@ -11,8 +11,10 @@ source 'http://rubygems.org'
 gemspec
 
 group :development do
-  gem 'guard'
-  gem 'guard-rspec'
+  if RUBY_VERSION >= '2.2.5'
+    gem 'guard'  
+    gem 'guard-rspec'
+  end
 end
 
 group :test do

data/README.md

@@ -1,4 +1,4 @@
-# Supplejack Client
+# Supplejack Client [![Gem Version](https://badge.fury.io/rb/supplejack_client.svg)](https://badge.fury.io/rb/supplejack_client)
 
 The Supplejack Client is a library to abstract the interaction with the Supplejack API. It connects to the Supplejack API, and allows you to treat models as if they were in a local database.
 
@@ -9,7 +9,7 @@ For more information on how to configure and use this application refer to the [
 Add it to your Gemfile:
 
 ```ruby
-gem 'supplejack_client', github: 'git@github.com:DigitalNZ/supplejack_client.git'
+gem 'supplejack_client', git: 'git@github.com:DigitalNZ/supplejack_client.git'
 ```
 
 Run bundle install:
@@ -150,4 +150,4 @@ This program is free software: you can redistribute it and/or modify it under th
 
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses / http://www.gnu.org/licenses/gpl-3.0.txt

+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses / http://www.gnu.org/licenses/gpl-3.0.txt


data/lib/generators/locales/en.yml

@@ -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
 
 en:
   supplejack_client:

data/lib/generators/supplejack/install_generator.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 Generators

data/lib/generators/templates/supplejack_client.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
 
 Supplejack.configure do |config|
 

data/lib/supplejack/concept.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
 
 require 'supplejack/search'
 

data/lib/supplejack/config.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 Config

data/lib/supplejack/controllers/helpers.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
 
 require 'rails_autolink'
 

data/lib/supplejack/engine.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
 
 require 'supplejack_client'
 require 'rails'

data/lib/supplejack/exceptions.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
   class RecordNotFound < StandardError
@@ -15,6 +17,9 @@ module Supplejack
   class SetNotFound < StandardError
   end
 
+  class StoryNotFound < StandardError
+  end
+
   class MalformedRequest < StandardError
   end
 end

data/lib/supplejack/facet.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
   class Facet

data/lib/supplejack/item.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
 
@@ -62,7 +64,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
@@ -77,7 +79,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

data/lib/supplejack/item_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
 
@@ -58,6 +60,7 @@ module Supplejack
     #
     def create(attributes={})
       item = self.build(attributes)
+
       item.save
     end
 
@@ -67,7 +70,7 @@ module Supplejack
     # @example
     #   user_set.items.each ....     => Iterate through the Item objects array
     #   user_set.items.size          => Get the size of the Item objects array
-    # 
+    #
     def method_missing(method, *args, &block)
       @items.send(method, *args, &block)
     end

data/lib/supplejack/log_subscriber.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
   class LogSubscriber < ActiveSupport::LogSubscriber

data/lib/supplejack/paginated_collection.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
   class PaginatedCollection

data/lib/supplejack/record.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
 
 require 'supplejack/search'
 

data/lib/supplejack/request.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
 
 require 'rest-client'
 
@@ -27,7 +29,7 @@ module Supplejack
         raise e
       ensure
         duration = (Time.now - started)*1000 # Convert to miliseconds
-        solr_request_params = result["search"]['solr_request_params'] if result && result['search']
+        solr_request_params = result["search"]['solr_request_params'] if result && result.is_a?(Hash) && result['search']
         @subscriber = Supplejack::LogSubscriber.new
         @subscriber.log_request(duration, payload, solr_request_params)
       end
@@ -66,6 +68,18 @@ module Supplejack
       end
     end
 
+    def patch(path, params: {}, payload: {}, options: {})
+      payload ||= {}
+      log_request(:patch, path, params, payload) do
+        response = RestClient::Request.execute(:url => full_url(path, nil, params),
+                                               :method => :patch,
+                                               :payload => payload.to_json,
+                                               :timeout => timeout(options),
+                                               :headers => {:content_type => :json, :accept => :json})
+        JSON.parse(response) rescue {}.to_json
+      end
+    end
+
     private
 
     def full_url(path, format=nil, params={})

data/lib/supplejack/search.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
 
 require 'supplejack/request'
 require 'digest/md5'

data/lib/supplejack/story.rb

@@ -0,0 +1,232 @@
+# 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 Story
+    extend Supplejack::Request
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    MODIFIABLE_ATTRIBUTES = [:name, :description, :privacy, :copyright, :featured, :approved, :tags, :record_ids].freeze
+    UNMODIFIABLE_ATTRIBUTES = [:id, :created_at, :updated_at, :number_of_items, :contents, :cover_thumbnail].freeze
+    ATTRIBUTES = (MODIFIABLE_ATTRIBUTES + UNMODIFIABLE_ATTRIBUTES).freeze
+
+    attr_accessor *ATTRIBUTES
+    attr_accessor :user, :errors, :api_key
+
+    # 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))
+      end
+    end
+
+    def initialize(attributes={})
+      @attributes = attributes.try(:symbolize_keys) || {}
+      @user = Supplejack::User.new(@attributes[:user])
+      self.attributes = @attributes
+    end
+
+    def items
+      @items ||= StoryItemRelation.new(self)
+    end
+
+    # Returns if the Story is persisted to the API or not.
+    #
+    # @return [ true, false ] True if the UserSet is persisted to the API, false if not.
+    #
+    def new_record?
+      self.id.blank?
+    end
+
+    def attributes
+      retrieve_attributes(ATTRIBUTES)
+    end
+
+    def api_attributes
+      retrieve_attributes(MODIFIABLE_ATTRIBUTES)
+    end
+
+    # Executes a POST request when the Story hasn't been persisted to the API, otherwise it executes
+    # 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 = self.class.post("/stories", {api_key: self.api_key}, {story: self.api_attributes})
+        else
+          self.attributes = self.class.patch("/stories/#{self.id}", payload: {story: 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 Story ID and the user's api_key
+    #
+    # 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 destroy
+      return false if self.new_record?
+
+      begin
+        self.class.delete("/stories/#{self.id}")
+
+        Rails.cache.delete("/users/#{self.api_key}/stories") if Supplejack.enable_caching
+
+        true
+      rescue StandardError => e
+        self.errors = e.message
+
+        false
+      end
+    end
+
+    # Fetches the Story information from the API again, in case it had changed.
+    #
+    # This can be useful if they items for a Story changed and you want the relation
+    # to have the most up to date items.
+    #
+    def reload
+      begin
+        self.attributes = self.class.get("/stories/#{self.id}")
+        @items = nil
+      rescue RestClient::ResourceNotFound
+        raise Supplejack::StoryNotFound, "Story with ID #{id} was not found"
+      end
+    end
+
+    # Executes a GET request with the provided Story ID and initializes
+    # a Story object with the response from the API.
+    #
+    # @return [ Story ] A Story object
+    #
+    def self.find(id, api_key: nil, params: {})
+      begin
+        response = get("/stories/#{id}", params)
+        attributes = response || {}
+
+        story = new(attributes)
+        story.api_key = api_key if api_key.present?
+
+        story
+      rescue RestClient::ResourceNotFound
+        raise Supplejack::StoryNotFound, "Story with ID #{id} was not found"
+      end
+    end
+
+    # Assigns the provided attributes to the Story object
+    #
+    def attributes=(attributes)
+      attributes = attributes.try(:symbolize_keys) || {}
+      attributes.each do |attr, value|
+        self.send("#{attr}=", value) if ATTRIBUTES.include?(attr)
+      end
+    end
+
+    # Updates the Story 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
+
+    # Returns the ApiKey of the User this Story belongs to
+    # If the api_key is set on the Story directly it uses that one instead
+    #
+    # @return [String] User ApiKey
+    def api_key
+      @api_key || @user.api_key
+    end
+
+    # Returns a comma separated list of tags for this Story
+    #
+    def tag_list
+      self.tags.join(', ') if self.tags
+    end
+
+    def private?
+      self.privacy == "private"
+    end
+
+    def public?
+      self.privacy == "public"
+    end
+
+    def hidden?
+      self.privacy == "hidden"
+    end
+
+    # A Story is viewable by anyone if it's public or hidden
+    # When the Story is private it's only viewable by the owner.
+    #
+    # @param [ Supplejack::User ] User to check if they can see it
+    #
+    # @return [ true, false ] True if the user can view the current Story, false if not.
+    #
+    def viewable_by?(user)
+      return true if self.public? || self.hidden?
+
+      self.owned_by?(user)
+    end
+
+    # Compares the api_key of the user and the api_key assigned to the Story
+    # to find out if the user passed is the owner of the story.
+    #
+    # @param [ Supplejack::User ] User to check if they own it
+    #
+    # @return [ true, false ] True if the user owns the current Story, false if not.
+    #
+    def owned_by?(user)
+      return false if user.try(:api_key).blank? || self.api_key.blank?
+
+      user.try(:api_key) == self.api_key
+    end
+
+    def as_json(include_contents: true)
+      include_contents ? attributes : attributes.except(:contents)
+    end
+
+    def to_json(include_contents: true)
+      as_json(include_contents: include_contents).to_json
+    end
+
+    private
+
+    def retrieve_attributes(attributes_list)
+      {}.tap do |attributes|
+        attributes_list.each do |attribute|
+          value = self.send(attribute)
+          attributes[attribute] = value
+        end
+      end
+    end
+
+  end
+end