supplejack_client 1.0.5 → 1.0.7

data/lib/supplejack/user_story_relation.rb

@@ -0,0 +1,141 @@
+# 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 UserStoryRelation
+    include Supplejack::Request
+
+    attr_reader :user
+
+    def initialize(user)
+      @user = user
+      @stories = []
+      # This is used to determine if we have requested the Stories from the API
+      # Previously @stories defaulted to nil so the ||= operator was used to determine
+      # whether to fetch. This was changed to allow built/created stories to be
+      # automatically included in the relation
+      @initial_fetch = false
+    end
+
+    # Returns an array of Story objects and memoizes the array
+    #
+    def fetch(force: false)
+      fetch_stories = -> { fetch_api_stories.map{|s| Supplejack::Story.new(s.merge(user: user.attributes))} }
+
+      @stories = if force
+                   fetch_stories.call
+                  elsif !@initial_fetch
+                    @initial_fetch = true
+                    fetch_stories.call
+                  else
+                    @stories
+                  end
+
+      @stories
+    end
+    alias_method :all, :fetch
+
+    # Finds a Story object with the provided ID that belongs to the current
+    # User
+    #
+    # @param [ String ] A 24 character string representing the Story ID
+    #
+    # @return [ Supplejack::Story ] A Story object
+    #
+    def find(story_id)
+      path = "/stories/#{story_id}"
+      build get(path, api_key: API_KEY)
+    end
+
+    # Initializes a new Story object and links it to the current User
+    #
+    # @param [ Hash ] A hash with the Story field names and values
+    #
+    # @return [ Supplejack::Story] A new Story object
+    #
+    def build(attributes={})
+      story = Supplejack::Story.new(attributes)
+      story.api_key = user.api_key
+
+      # Possible at some point in the future we'll want
+      # to change this to something more robust.
+      #
+      # Just not sure if unsaved Stories being in this
+      # will ever be a problem or not
+      @stories << story
+
+      story
+    end
+
+    # Build and persist a Story object with the provided attributes
+    #
+    # @param [ Hash ] A hash with the Story field names and values
+    #
+    # @return [ Supplejack::Story ] A persisted Story object
+    #
+    def create(attributes={})
+      story = build(attributes)
+      story.save
+
+      story
+    end
+
+    # Return an array of Story objects ordered in ascending order
+    # by the specified attribute.
+    #
+    # @param [ Symbol ] A symbol with the attribute to order the Story objects on
+    #
+    # @return [ Array ] A array of Supplejack::Story objects.
+    #
+    def order(attribute)
+      @stories = all.sort_by do |story|
+        value = story.send(attribute)
+        value = value.downcase if value.is_a?(String)
+
+        value
+      end
+    end
+
+    def to_json(include_contents: true)
+      all.map{|story| story.as_json(include_contents: include_contents)}.to_json
+    end
+
+    # Any method missing on this class is delegated to the Stories objects array
+    # so that the developer can easily execute any Array method on the UserSttoryRelation
+    #
+    # @example
+    #   user.stories.each ....     => Iterate through the Story objects array
+    #   user.stories.size          => Get the size of the Story objects array
+    #
+    def method_missing(method, *args, &block)
+      all.send(method, *args, &block)
+    end
+
+    private
+
+    def fetch_api_stories
+      params = {}
+
+      if user.use_own_api_key?
+        path = "/stories"
+        params[:api_key] = user.api_key
+      else
+        path = "/users/#{user.api_key}/stories"
+      end
+
+      if Supplejack.enable_caching
+        Rails.cache.fetch(path, expires_in: 1.day) do
+          get(path, params)
+        end
+      else
+        get(path, params)
+      end
+    end
+  end
+end

data/lib/supplejack/util.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 Util

data/lib/supplejack/version.rb

@@ -1,10 +1,12 @@
-# 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
-  VERSION = '1.0.5'
-end
+  VERSION = '1.0.7'
+end

data/lib/supplejack_client.rb

@@ -1,9 +1,16 @@
-# 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
+
+begin
+  require 'pry'
+rescue LoadError
+end
 
 require 'supplejack/config'
 require 'supplejack/version'
@@ -23,8 +30,12 @@ module Supplejack
   require 'supplejack/util'
   require 'supplejack/facet'
   require 'supplejack/user_set'
+  require 'supplejack/story'
+  require 'supplejack/story_item'
+  require 'supplejack/story_item_relation'
   require 'supplejack/item_relation'
   require 'supplejack/item'
   require 'supplejack/user'
   require 'supplejack/user_set_relation'
+  require 'supplejack/user_story_relation'
 end

data/spec/spec_helper.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 'rubygems'
 require 'bundler/setup'
@@ -14,8 +16,8 @@ Bundler.require(:default)
 require 'supplejack_client'
 require 'active_support/all'
 
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 #SimpleCov.start
 

data/spec/supplejack/concept_spec.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 'spec_helper'
 

data/spec/supplejack/facet_spec.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 'spec_helper'
 

data/spec/supplejack/item_relation_spec.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 'spec_helper'
 

data/spec/supplejack/item_spec.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 'spec_helper'
 
@@ -65,7 +67,7 @@ module Supplejack
 
         it 'stores the error when a error is raised' do
           item.save
-          item.errors.should eq 'Forbidden: '
+          item.errors.should eq 'Forbidden'
         end
       end
     end
@@ -89,7 +91,7 @@ module Supplejack
 
         it 'stores the error when a error is raised' do
           item.destroy
-          item.errors.should eq 'Forbidden: '
+          item.errors.should eq 'Forbidden'
         end
       end
     end

data/spec/supplejack/log_subscriber_spec.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 'spec_helper'
 

data/spec/supplejack/paginated_collection_spec.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 'spec_helper'
 

data/spec/supplejack/record_spec.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 'spec_helper'
 

data/spec/supplejack/request_spec.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 'spec_helper'
 

data/spec/supplejack/search_spec.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 'spec_helper'
 

data/spec/supplejack/story_item_relation_spec.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
+
+require 'spec_helper'
+
+module Supplejack
+  describe ItemRelation do
+    let(:supplejack_story) do
+      Supplejack::Story.new(
+        id: '1234567890',
+        user: {api_key: 'foobar'},
+        name: 'test',
+        contents: [
+          {id: 1, type: 'embed', sub_type: 'dnz', position: 1},
+          {id: 2, type: 'embed', sub_type: 'dnz', position: 2}
+        ]
+      )
+    end
+    let(:relation) { Supplejack::StoryItemRelation.new(supplejack_story) }
+
+    describe '#initialize' do
+      it 'assigns the story object as @story' do
+        expect(relation.story).to eq(supplejack_story)
+      end
+
+      it 'initializes an array of Supplejack::Items' do
+        expect(relation.all).to be_an Array
+      end
+
+      it 'returns an empty array of items when the user_set attributes records are nil' do
+        expect(supplejack_story).to receive(:attributes).and_return(nil)
+
+        expect(relation.all).to be_empty
+      end
+
+      it 'adds the story_id to the Supplejack::StoryItem object' do
+        expect(relation.all.first.story_id).to eq('1234567890')
+      end
+
+      it 'adds the api_key in the Story to the Supplejack::StoryItem' do
+        expect(relation.all.first.api_key).to eq('foobar')
+      end
+    end
+
+    describe '#all' do
+      it 'returns the array of @items' do
+        expect(supplejack_story.items.all).to be_an Array
+      end
+    end
+
+    describe '#find' do
+      it 'returns finds the item by record_id' do
+        item = relation.find(1)
+        expect(item).to be_a Supplejack::StoryItem
+        expect(item.id).to eq(1)
+      end
+
+      it 'finds the item by a string record_id' do
+        item = relation.find('1')
+
+        expect(item).to be_a Supplejack::StoryItem
+        expect(item.id).to eq(1)
+      end
+    end
+
+    describe '#build' do
+      it 'initializes a new item object with the user_set_id' do
+        item = relation.build
+
+        expect(item.story_id).to eq('1234567890')
+      end
+
+      it 'accepts a hash of attributes' do
+        item = relation.build(type: 'embed', sub_type: 'dnz')
+
+        expect(item.type).to eq('embed')
+        expect(item.sub_type).to eq('dnz')
+      end
+
+      it 'adds the Story api_key' do
+        item = relation.build
+
+        expect(item.api_key).to eq('foobar')
+      end
+    end
+
+    describe '#create' do
+      let(:item) { double(:item).as_null_object }
+
+      it 'builds and saves the item' do
+        expect(relation).to receive(:build) { item }
+        expect(item).to receive(:save)
+
+        relation.create
+      end
+
+      it 'passes the parameters along to the build method' do
+        expect(relation).to receive(:build).with(type: 'embed') { item }
+
+        relation.create(type: 'embed')
+      end
+    end
+
+    describe '#move_item' do
+      let(:item) { relation.all.first }
+
+      before do
+        expect(relation).to receive(:post).with(
+          "/stories/#{supplejack_story.id}/items/#{item.id}/moves",
+          {api_key: 'foobar'},
+          {item_id: 1, position: 2}
+        ).and_return([
+          {id: 2, type: 'embed', sub_type: 'dnz', position: 1},
+          {id: 1, type: 'embed', sub_type: 'dnz', position: 2}
+        ])
+      end
+
+      it 'calls the api move item endpoint with the new position' do
+        relation.move_item(item.id, 2)
+      end
+
+      it 'updates the items with the response' do
+        relation.move_item(item.id, 2)
+
+        expect(relation.all.first.id).to eq(2)
+      end
+    end
+
+    context 'items array behaviour' do
+      it 'executes array methods on the @items array' do
+        expect(relation.any?{|x| x.id == 1}).to eq(true)
+      end
+
+      it 'should be able to iterate through the items relation' do
+        relation.each do |item|
+          expect(item).to be_a Supplejack::StoryItem
+        end
+
+        expect(relation.size).to eq(2)
+      end
+    end
+  end
+end