supplejack_client 1.0.5 → 1.0.7

data/spec/supplejack/user_set_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/user_set_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'
 
@@ -245,7 +247,7 @@ module Supplejack
         end
       end
     end
-    
+
     describe '#api_records' do
       it 'generates a hash of records with position and record_id' do
         supplejack_set.stub(:records) { [{title: 'Hi', record_id: 1, position: 1} ] }
@@ -293,7 +295,7 @@ module Supplejack
       it 'returns false when the response is not a 200' do
         Supplejack::UserSet.stub(:delete).and_raise(RestClient::Forbidden.new)
         supplejack_set.destroy.should be_false
-        supplejack_set.errors.should eq 'Forbidden: '
+        supplejack_set.errors.should eq 'Forbidden'
       end
 
       it 'returns false when it is a new user set' do
@@ -358,7 +360,7 @@ module Supplejack
 
     describe '#owned_by?' do
       let(:user) { double(:user, api_key: '123456') }
-      
+
       it 'returns true when the users api_key is the same as the set\'s' do
         supplejack_set.stub(:api_key) { "123456" }
         supplejack_set.owned_by?(user).should be_true
@@ -398,7 +400,7 @@ module Supplejack
       end
 
       it 'fetches the set from the api' do
-        Supplejack::UserSet.should_receive(:get).with('/sets/123abc')
+        Supplejack::UserSet.should_receive(:get).with('/sets/123abc', {})
         Supplejack::UserSet.find('123abc')
       end
 

data/spec/supplejack/user_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/user_story_relation_spec.rb

@@ -0,0 +1,157 @@
+# 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 UserStoryRelation do
+    let(:user) { Supplejack::User.new({authentication_token: '123abc'}) }
+    let(:relation) { Supplejack::UserStoryRelation.new(user) }
+
+    before do
+      relation.stub(:get) do
+        [
+          {
+            'id' => '1',
+            'name' => 'dogs',
+            'description' => 'desc',
+            'privacy' => "public",
+            'featured' => false,
+            'approved' => true,
+            'number_of_items' => 1,
+          },
+          {
+            'id' => '2',
+            'name' => 'cats',
+            'description' => 'desc',
+            'privacy' => "public",
+            'featured' => false,
+            'approved' => true,
+            'number_of_items' => 1,
+          },
+        ]
+      end
+    end
+
+    describe '#initialize' do
+      it 'initializes with a UserSet object' do
+        expect(Supplejack::UserStoryRelation.new(user).user).to eq(user)
+      end
+    end
+
+    describe '#fetch' do
+      context 'use_own_api_key? is false' do
+        it 'fetches the users stories with the App api_key' do
+          expect(relation).to receive(:get).with('/users/123abc/stories', {})
+
+          relation.fetch
+        end
+      end
+
+      context 'use_own_api_key? is true' do
+        let(:user) {Supplejack::User.new(api_key: '123abc', use_own_api_key: true)}
+
+        it 'fetches the users stories with their api_key' do
+          expect(relation).to receive(:get).with('/stories', {api_key: '123abc'})
+
+          relation.fetch
+        end
+      end
+
+      it 'returns a array of Story objects' do
+        expect(relation.fetch).to be_a Array
+
+        relation.fetch.each do |story|
+          expect(story).to be_a Supplejack::Story
+        end
+      end
+
+      it 'memoizes the result' do
+        expect(relation).to receive(:fetch_api_stories).once { [] }
+
+        relation.fetch
+        relation.fetch
+      end
+
+      it 'lets you force a refetch' do
+        expect(relation).to receive(:fetch_api_stories).twice { [] }
+
+        relation.fetch
+        relation.fetch(force: true)
+      end
+    end
+
+    describe '#build' do
+      it "initializes a new Story with the user's api_key" do
+        story = relation.build
+
+        expect(story).to be_a Supplejack::Story
+        expect(story.api_key).to eq('123abc')
+      end
+
+      it 'initializes the Story with the provided attributes' do
+        story = relation.build({name: 'Dogs', description: 'Hi'})
+
+        expect(story.name).to eq('Dogs')
+        expect(story.description).to eq('Hi')
+      end
+    end
+
+    describe '#create' do
+      it 'initializes the Story and saves it' do
+        story = relation.build({name: 'Dogs'})
+        allow(relation).to receive(:build).with(name: 'Dogs') { story }
+
+        expect(story).to receive(:save) { true }
+
+        expect(relation.create({name: 'Dogs'})).to be_a Supplejack::Story
+      end
+
+      it 'adds the new Story to the relation' do
+        expect(relation.count).to eq(2)
+        relation.create(name: 'Dogs')
+        expect(relation.count).to eq(3)
+      end
+    end
+
+    describe '#order' do
+      before do
+        relation.stub(:get) do
+          [
+            {'name' => 'dogs'},
+            {'name' => 'zavourites'},
+            {'name' => 'Favourites'}
+          ]
+        end
+      end
+
+      it 'orders the stories based on the supplied field' do
+        ordered_relations = relation.order(:name)
+
+        expect(ordered_relations[0].name).to eq('dogs')
+        expect(ordered_relations[1].name).to eq('Favourites')
+        expect(ordered_relations[2].name).to eq('zavourites')
+      end
+    end
+
+    describe '#all' do
+      it 'it is an alias to #fetch' do
+        expect(relation.all).to eq(relation.fetch)
+      end
+    end
+
+    context 'stories array behaviour' do
+      it 'executes array methods on the @stories array' do
+        relation.stub(:all) { [] }
+
+        expect(relation.size).to eq(0)
+      end
+    end
+  end
+end

data/stories_integration_test.rb

@@ -0,0 +1,97 @@
+def assert(left, right, message)
+  ok = left == right
+  p message unless ok
+  p "#{left} != #{right}" unless ok
+end
+
+# Setup
+p 'Setup'
+
+Supplejack.api_key = ENV['SJ_CLIENT_TEST_KEY']
+user = Supplejack::User.new(api_key: ENV['SJ_CLIENT_TEST_KEY'])
+user.stories.each(&:destroy)
+user.stories.fetch(force: true)
+
+p 'Done Setup'
+
+# Create story
+p 'Create Story'
+
+user.stories.create(name: 'Test story')
+
+assert(user.stories.first.name, 'Test story', 'name of story does not match')
+
+p 'Done Create Story'
+
+# Update story
+p 'Update Story'
+user.stories.first.update_attributes(name: 'A new name', description: 'fizzle', tags: ['love', 'me', 'some', 'tags'])
+
+assert(user.stories.first.name, 'A new name', 'name of story does not match')
+assert(user.stories.first.description, 'fizzle', 'description of story does not match')
+assert(user.stories.first.tags, ['love', 'me', 'some', 'tags'], 'tags of story does not match')
+
+p 'Done Update Story'
+
+# Create items
+p 'Create Items'
+
+assert(user.stories.first.items.create(type: 'embed', sub_type: 'dnz', content: {record_id: 123}, meta: {}), true, 'dnz embed item failed to create')
+assert(user.stories.first.items.create(type: 'text', sub_type: 'heading', content: {value: 'Heading'}, meta: {size: 1}), true, 'heading item failed to create')
+
+assert(user.stories.first.items.first.content[:record_id], 123, 'record_id does not match')
+assert(user.stories.first.items.last.content[:value], 'Heading', 'heading value does not match')
+assert(user.stories.first.items.count, 2, 'two items were not created')
+
+p 'Done Create Items'
+
+# Update item
+p 'Update Item'
+
+user.stories.first.items.first.update_attributes(content: {record_id: 456})
+
+assert(user.stories.first.items.first.content, {record_id: 456}, 'record_id does not match')
+
+p 'Done Update Item'
+
+# Move item
+p 'Move Item'
+
+id = user.stories.first.items.first.id
+user.stories.first.items.move_item(id, 2)
+
+assert(user.stories.first.items.last.id, id, 'block did not get moved')
+
+p 'Done Move Item'
+
+# Delete item
+p 'Delete Item'
+
+user.stories.first.items.first.destroy
+
+p 'Done Delete Item'
+
+# Force refetch of stories
+p 'Force refetch'
+
+start = Time.now
+user.stories.fetch(force: true)
+end_time = Time.now
+
+if ((start - end_time) * 1000) > 100
+  p 'did not refetch'
+end
+# Have to refetch to check if item is deleted, so I put it here
+assert(user.stories.first.items.count, 1, 'item was not deleted')
+
+p 'Done Force refetch'
+
+# Delete story
+p 'Delete Story'
+
+user.stories.first.destroy
+user.stories.fetch(force: true)
+
+assert(user.stories.count, 0, 'story was not deleted')
+
+p 'Done Delete Story'

data/supplejack_client.gemspec

@@ -21,11 +21,17 @@ Gem::Specification.new do |gem|
   gem.name          = 'supplejack_client'
   gem.require_paths = ['lib']
   gem.version       = Supplejack::VERSION
-
-  gem.add_dependency 'rails', '>= 3.2.12', '< 5.0'
-  gem.add_dependency 'rest-client', '~> 1.6'
+  
+  if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new("2.2.2")
+    gem.add_dependency 'rails', '>= 3.2.12', '< 5.0'
+  else
+    gem.add_dependency 'rails', '>= 3.2.12'
+  end
+  
+  gem.add_dependency 'rest-client', '~> 2.0'
   gem.add_dependency 'rails_autolink', '~> 1.0'
   
   gem.add_development_dependency 'rspec', '~> 2.8'
   gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supplejack_client
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Supplejack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.12
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,23 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.12
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails_autolink
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Library to abstract the interaction with the Supplejack API "
 email:
 - info@digitalnz.org
@@ -97,6 +105,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -120,10 +129,14 @@ files:
 - lib/supplejack/record.rb
 - lib/supplejack/request.rb
 - lib/supplejack/search.rb
+- lib/supplejack/story.rb
+- lib/supplejack/story_item.rb
+- lib/supplejack/story_item_relation.rb
 - lib/supplejack/url_formats/item_hash.rb
 - lib/supplejack/user.rb
 - lib/supplejack/user_set.rb
 - lib/supplejack/user_set_relation.rb
+- lib/supplejack/user_story_relation.rb
 - lib/supplejack/util.rb
 - lib/supplejack/version.rb
 - lib/supplejack_client.rb
@@ -138,10 +151,15 @@ files:
 - spec/supplejack/record_spec.rb
 - spec/supplejack/request_spec.rb
 - spec/supplejack/search_spec.rb
+- spec/supplejack/story_item_relation_spec.rb
+- spec/supplejack/story_item_spec.rb
+- spec/supplejack/story_spec.rb
 - spec/supplejack/url_formats/item_hash_spec.rb
 - spec/supplejack/user_set_relation_spec.rb
 - spec/supplejack/user_set_spec.rb
 - spec/supplejack/user_spec.rb
+- spec/supplejack/user_story_relation_spec.rb
+- stories_integration_test.rb
 - supplejack_client.gemspec
 homepage: http://digitalnz.org
 licenses: []
@@ -179,7 +197,11 @@ test_files:
 - spec/supplejack/record_spec.rb
 - spec/supplejack/request_spec.rb
 - spec/supplejack/search_spec.rb
+- spec/supplejack/story_item_relation_spec.rb
+- spec/supplejack/story_item_spec.rb
+- spec/supplejack/story_spec.rb
 - spec/supplejack/url_formats/item_hash_spec.rb
 - spec/supplejack/user_set_relation_spec.rb
 - spec/supplejack/user_set_spec.rb
 - spec/supplejack/user_spec.rb
+- spec/supplejack/user_story_relation_spec.rb