strutta-api 1.0.1

data/spec/games_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe 'Strutta API Wrapper' do
+
+  before { WebMock.disable_net_connect!(allow_localhost: true, allow: /codeclimate/) }
+  after { WebMock.allow_net_connect! }
+
+  let(:token) { 'dc1479c52801fbfa0975947de092a1e7' }
+  let(:host) { 'http://api.strutta.dev:4000' }
+  let(:path) { '/v2/' }
+  let(:strutta) { Strutta::API.new token, host, path }
+
+  let(:game) { strutta.games.create }
+
+  describe '.games' do
+    context 'when no id is given' do
+      context '.get' do
+        it 'should throw error' do
+          expect { strutta.games.get }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.update' do
+        it 'should throw error' do
+          expect { strutta.games.update(title: 'title') }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw error' do
+          expect { strutta.games.delete }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.rounds' do
+        it 'should throw error' do
+          expect { strutta.games.rounds }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.participants' do
+        it 'should throw error' do
+          expect { strutta.games.participants }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.flow' do
+        it 'should throw error' do
+          expect { strutta.games.flow }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.entries' do
+        it 'should throw error' do
+          expect { strutta.games.entries }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.all' do
+        before do
+          stub_request(:get, /.*games/)
+           .to_return(status: 200, body: GAME_INDEX.to_json, headers: {})
+        end
+        it 'should return array of games' do
+          games = strutta.games.all
+          results = games['results']
+          expect(results.is_a? Array).to be true
+          expect(results.first['id']).to_not be nil
+          expect(results.first['entries_count']).to_not be nil
+          expect(results.last['id']).to_not be nil
+          expect(results.last['entries_count']).to_not be nil
+          expect(games['paging']['min_id']).to equal VALID_GAME_01[:id]
+          expect(games['paging']['max_id']).to equal VALID_GAME_02[:id]
+        end
+      end
+
+      context '.create' do
+        before do
+          stub_request(:post, /.*games/)
+           .to_return(status: 201, body: VALID_GAME_01.to_json, headers: {})
+        end
+        it 'should return a new game hash' do
+          expect(game['id']).to eq VALID_GAME_01[:id]
+        end
+      end
+    end
+
+    context 'when id is given' do
+      before do
+        stub_request(:post, /.*games/)
+         .to_return(status: 201, body: VALID_GAME_02.to_json, headers: {})
+        stub_request(:get, /.*games\/\d+/)
+         .to_return(status: 200, body: VALID_GAME_02.to_json, headers: {})
+      end
+      context '.get' do
+        it 'should return game hash' do
+          g = strutta.games(game['id']).get
+          expect(g['id']).to eq VALID_GAME_02[:id]
+        end
+      end
+
+      context '.update' do
+        before do
+          stub_request(:post, /.*games/)
+           .to_return(status: 200, body: VALID_GAME_01.to_json, headers: {})
+          stub_request(:patch, /.*games\/\d+/)
+           .to_return(status: 200, body: VALID_GAME_01_UPDATED.to_json, headers: {})
+        end
+        it 'should return updated game hash' do
+          updated = strutta.games(game['id']).update(title: 'updated')
+          expect(updated['title']).to eq('updated')
+        end
+      end
+
+      context '.delete' do
+        before do
+          stub_request(:post, /.*games/)
+           .to_return(status: 201, body: VALID_GAME_02.to_json, headers: {})
+          stub_request(:delete, /.*games\/\d+/)
+           .to_return(status: 204, body: nil, headers: {})
+        end
+        it 'should delete game' do
+          expect(strutta.games(game['id']).delete).to be true
+        end
+      end
+
+      context 'check proper object returns' do
+
+        before do
+          stub_request(:post, /.*games/)
+           .to_return(status: 201, body: VALID_GAME_02.to_json, headers: {})
+        end
+
+        context '.rounds' do
+          it 'should return a Rounds object' do
+            rounds = strutta.games(game['id']).rounds
+            expect(rounds.is_a? Strutta::Rounds).to be true
+          end
+        end
+
+        context '.participants' do
+          it 'should return a Participants object' do
+            participants = strutta.games(game['id']).participants
+            expect(participants.is_a? Strutta::Participants).to be true
+          end
+        end
+
+        context '.flow' do
+          it 'should return a Flow object' do
+            flow = strutta.games(game['id']).flow
+            expect(flow.is_a? Strutta::Flow).to be true
+          end
+        end
+
+        context '.entries' do
+          it 'should return a Entries object' do
+            entries = strutta.games(game['id']).entries
+            expect(entries.is_a? Strutta::Entries).to be true
+          end
+        end
+
+        context '.all' do
+          it 'should throw error' do
+            expect { strutta.games(game['id']).all }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+          end
+        end
+
+        context '.create' do
+          it 'should throw error' do
+            expect { strutta.games(game['id']).create }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/judging_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe 'Strutta API Wrapper' do
+
+  before { WebMock.disable_net_connect!(allow_localhost: true, allow: /codeclimate/) }
+  after { WebMock.allow_net_connect! }
+
+  let(:token) { 'dc1479c52801fbfa0975947de092a1e7' }
+  let(:host) { 'http://api.strutta.dev:4000' }
+  let(:path) { '/v2/' }
+  let(:strutta) { Strutta::API.new token, host, path }
+
+  let(:new_game) { strutta.games.create }
+  let(:game) { strutta.games(VALID_GAME_01[:id]) }
+
+  let(:judgments) do
+    [
+      {
+        entry_id: 1234,
+        rank: 1,
+        metadata: {
+          comments: 'First place'
+        }
+      },
+      {
+        entry_id: 1235,
+        rank: 2,
+        metadata: {
+          comments: 'Second place'
+        }
+      },
+      {
+        entry_id: 1236,
+        rank: 3,
+        metadata: {
+          comments: 'Third place'
+        }
+      }
+    ]
+  end
+
+  describe 'games(:id).judging' do
+    context 'when no id is given' do
+
+      context '.create' do
+        context 'with valid parameters' do
+          before do
+            stub_request(:post, /.*judging/)
+             .to_return(status: 201, body: JUDGING_RESPONSE.to_json, headers: {})
+          end
+          it 'should return a new flow hash' do
+            judging = strutta.games(333).judging.create(judgments)
+            expect(judging['message']).to eq JUDGING_RESPONSE[:message]
+          end
+        end
+      end
+
+      context '.get' do
+        before do
+          stub_request(:get, /.*judging/)
+           .to_return(status: 200, body: JUDGING_GET_RESPONSE.to_json, headers: {})
+        end
+        it 'should throw disabled endpoint error' do
+          judging = strutta.games(333).judging.get(round_id: JUDGING_ROUND[:id])
+          expect(judging['round_id'].is_a? Integer).to be true
+          expect(judging['judging'].is_a? Array).to be true
+          expect(judging['judging'].first['judgments'].is_a? Array).to be true
+        end
+      end
+
+      context '.all' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging.all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.update' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging.update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging.delete({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+    end
+
+    context 'when id is given' do
+      context '.all' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging(1).all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.update' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging(1).update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw disabled endpoint error' do
+          expect { game.judging(1).delete({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.create' do
+        it 'should throw error' do
+          expect { game.judging(1).create }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.get' do
+        it 'should throw error' do
+          expect { game.judging(1).create }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+    end
+  end
+end

data/spec/moderation_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe 'Strutta API Wrapper' do
+
+  before { WebMock.disable_net_connect!(allow_localhost: true, allow: /codeclimate/) }
+  after { WebMock.allow_net_connect! }
+
+  let(:token) { 'dc1479c52801fbfa0975947de092a1e7' }
+  let(:host) { 'http://api.strutta.dev:4000' }
+  let(:path) { '/v2/' }
+  let(:strutta) { Strutta::API.new token, host, path }
+
+  let(:new_game) { strutta.games.create }
+  let(:game) { strutta.games(VALID_GAME_01[:id]) }
+
+  let(:moderation_post) do
+    [
+      {
+        id: ENTRY_01[:id],
+        pass: true
+      },
+      {
+        id: ENTRY_02[:id],
+        pass: false
+      },
+      {
+        id: ENTRY_03[:id],
+        pass: false
+      }
+    ]
+  end
+
+  describe 'games(:id).moderation' do
+    context 'when no id is given' do
+
+      context '.create' do
+        context 'with valid parameters' do
+          before do
+            stub_request(:post, /.*moderation/)
+             .to_return(status: 201, body: MODERATION_POST_RESPONSE.to_json, headers: {})
+          end
+          it 'should return a new flow hash' do
+            moderation = strutta.games(333).moderation.create(moderation: moderation_post)
+            expect(moderation['results'].is_a? Array).to be true
+            expect(moderation['results'].first['id'].is_a? Integer).to be true
+            expect(moderation['results'].first['state'].is_a? Integer).to be true
+          end
+        end
+      end
+
+      context '.get' do
+        before do
+          stub_request(:get, /.*moderation/)
+           .to_return(status: 200, body: MODERATION_GET.to_json, headers: {})
+        end
+        it 'should throw disabled endpoint error' do
+          moderation = strutta.games(333).moderation.get
+          expect(moderation['results'].is_a? Array).to be true
+          expect(moderation['results'].first['id'].is_a? Integer).to be true
+        end
+      end
+
+      context '.all' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation.all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.update' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation.update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation.delete({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+    end
+
+    context 'when id is given' do
+      context '.all' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation(1).all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.update' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation(1).update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw disabled endpoint error' do
+          expect { game.moderation(1).delete({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.create' do
+        it 'should throw error' do
+          expect { game.moderation(1).create }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.get' do
+        it 'should throw error' do
+          expect { game.moderation(1).create }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+    end
+  end
+end

data/spec/participants_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe 'Strutta API Wrapper' do
+
+  before { WebMock.disable_net_connect!(allow_localhost: true, allow: /codeclimate/) }
+  after { WebMock.allow_net_connect! }
+
+  let(:token) { 'dc1479c52801fbfa0975947de092a1e7' }
+  let(:host) { 'http://api.strutta.dev:4000' }
+  let(:path) { '/v2/' }
+  let(:strutta) { Strutta::API.new token, host, path }
+  let(:game) { strutta.games(VALID_GAME_01[:id]) }
+  let(:participant) { game.participants.create(email: 'test@test.com') }
+
+  describe 'games(:id).participants' do
+    context 'when no id is given' do
+      context '.get' do
+        it 'should throw error' do
+          expect { strutta.games.participants.get }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.update' do
+        it 'should throw error' do
+          expect { strutta.games.participants.update(title: 'title') }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw error' do
+          expect { strutta.games.participants.delete }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.token_renew' do
+        it 'should throw error' do
+          expect { strutta.games.participants.token_renew }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.permissions' do
+        it 'should throw error' do
+          expect { strutta.games.participants.permissions }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.permissions_update' do
+        it 'should throw error' do
+          expect { strutta.games.participants.permissions_update }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.all' do
+        before do
+          stub_request(:get, /.*participants/)
+           .to_return(status: 200, body: PARTICIPANT_INDEX.to_json, headers: {})
+        end
+        it 'should return array of participants' do
+          participant_list = game.participants.all
+          expect(participant_list.is_a? Array).to be true
+        end
+      end
+
+      context '.create' do
+        context 'with valid parameters' do
+          before do
+            stub_request(:post, /.*participants/)
+             .to_return(status: 201, body: PARTICIPANT_01.to_json, headers: {})
+          end
+          it 'should return a new participant hash' do
+            expect(participant['id']).to_not be nil
+          end
+        end
+      end
+
+      context '.search' do
+        context 'with valid parameters and existing participant' do
+          before do
+            stub_request(:get, /.*participants\/search/)
+             .to_return(status: 200, body: PARTICIPANT_01.to_json, headers: {})
+          end
+          it 'should return a new participant hash' do
+            p = game.participants.search(email: PARTICIPANT_01[:email])
+            expect(p['id']).to_not be nil
+          end
+        end
+
+        context 'with valid parameters and no existing participant' do
+          before do
+            stub_request(:get, /.*participants\/search/)
+             .to_return(status: 404, body: { error: 'not found', message: 'not found' }.to_json, headers: {})
+          end
+          it 'should throw object not found error' do
+            expect { game.participants.search(email: PARTICIPANT_01[:email]) }.to raise_error(Strutta::Errors::ObjectNotFoundError)
+          end
+        end
+
+        context 'with invalid parameters' do
+          it 'should throw invalid parameters error' do
+            expect { game.participants.search(name: PARTICIPANT_01[:id]) }.to raise_error(Strutta::Errors::InvalidSearchParameters)
+          end
+        end
+      end
+    end
+
+    context 'when id is given' do
+      context '.get' do
+        before do
+          stub_request(:get, /.*participants\/\d+/)
+           .to_return(status: 200, body: PARTICIPANT_01.to_json, headers: {})
+        end
+        it 'should return participant hash' do
+          p = game.participants(PARTICIPANT_01[:id]).get
+          expect(p['id']).to_not be nil
+        end
+      end
+
+      context '.update' do
+        before do
+          stub_request(:patch, /.*participants\/\d+/)
+           .to_return(status: 200, body: PARTICIPANT_01_UPDATED.to_json, headers: {})
+        end
+        it 'should return updated game hash' do
+          metadata = { age: 20 }
+          updated = game.participants(PARTICIPANT_01[:id]).update(metadata: metadata)
+          expect(updated['metadata']['age']).to eq(20)
+        end
+      end
+
+      context '.token_renew' do
+        before do
+          stub_request(:patch, %r{.*participants\/\d+\/token})
+           .to_return(status: 200, body: PARTICIPANT_TOKEN_RENEW.to_json, headers: {})
+        end
+        it 'should return updated token information' do
+          body = game.participants(PARTICIPANT_01[:id]).token_renew
+          expect(body['token']).not_to be nil
+          expect(body['token_expired']).to be false
+        end
+      end
+
+      context '.permissions' do
+        before do
+          stub_request(:get, %r{.*participants\/\d+\/permissions})
+           .to_return(status: 200, body: PARTICIPANT_PERMISSIONS.to_json, headers: {})
+        end
+        it 'should return permissions array' do
+          body = game.participants(PARTICIPANT_01[:id]).permissions
+          expect(body['permissions'].is_a? Array).to be true
+          expect(body['permissions'].include?('api_basic')).to be true
+          expect(body['permissions'].include?('moderate')).to be true
+        end
+      end
+
+      context '.permissions_update' do
+        before do
+          stub_request(:patch, %r{.*participants\/\d+\/permissions})
+           .to_return(status: 200, body: PARTICIPANT_PERMISSIONS_UPDATED.to_json, headers: {})
+        end
+        it 'should return permissions array' do
+          body = game.participants(PARTICIPANT_01[:id]).permissions_update
+          expect(body['permissions'].is_a? Array).to be true
+          expect(body['permissions'].include?('api_basic')).to be true
+          expect(body['permissions'].include?('moderate')).to be false
+        end
+      end
+
+      context '.delete' do
+        before do
+          stub_request(:delete, /.*participants\/\d+/)
+           .to_return(status: 204, body: '', headers: {})
+        end
+        it 'should delete participant' do
+          expect(game.participants(PARTICIPANT_01[:id]).delete).to be true
+        end
+      end
+
+      context '.all' do
+        it 'should throw error' do
+          expect { game.participants(PARTICIPANT_01[:id]).all }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.create' do
+        it 'should throw error' do
+          expect { game.participants(PARTICIPANT_01[:id]).create(email: 'test@email.com') }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+    end
+  end
+end