strutta-api 1.0.1

data/spec/fixtures/flow_fixtures.rb

@@ -0,0 +1,34 @@
+FLOW = {
+  flow: [
+    {
+      id: 4279,
+      pass_round: 4284,
+      fail_round: nil,
+      start: true,
+      title: 'my sub round',
+      type: 'submission',
+      start_date: 1406670635,
+      end_date: 1406680635
+    },
+    {
+      id: 4284,
+      pass_round: 4285,
+      fail_round: nil,
+      start: nil,
+      title: 'my rb round',
+      type: 'random_draw',
+      start_date: 1406680639,
+      end_date: 1406690639
+    },
+    {
+      id: 4285,
+      pass_round: nil,
+      fail_round: nil,
+      start: nil,
+      title: 'my pf round',
+      type: 'prize_fulfillment',
+      start_date: 1406700640,
+      end_date: 1406710640
+    }
+  ]
+}

data/spec/fixtures/games_fixtures.rb

@@ -0,0 +1,131 @@
+VALID_GAME_01 = {
+  id: 2534,
+  title: nil,
+  metadata: nil,
+  flow:
+    [
+      {
+        id: 2780,
+        pass_round: 2781,
+        fail_round: nil,
+        start: true,
+        title: 'my sub round',
+        type: 'submission',
+        start_date: 1406065397,
+        end_date: 1406075397
+      },
+      {
+        id: 2781,
+        pass_round: 2782,
+        fail_round: nil,
+        start: nil,
+        title: 'my rb round',
+        type: 'random_draw',
+        start_date: 1406075397,
+        end_date: 1406085397
+      },
+      {
+        id: 2782,
+        pass_round: nil,
+        fail_round: nil,
+        start: nil,
+        title: 'my pf round',
+        type: 'prize_fulfillment',
+        start_date: 1406095398,
+        end_date: 1406105398
+      }
+    ],
+  entries_count: 1,
+  rounds_count: 3,
+  participants_count: 1
+}
+VALID_GAME_01_UPDATED = {
+  id: 2680,
+  title: 'updated',
+  metadata: nil,
+  flow:
+    [
+      {
+        id: 2780,
+        pass_round: 2781,
+        fail_round: nil,
+        start: true,
+        title: 'my sub round',
+        type: 'submission',
+        start_date: 1406065397,
+        end_date: 1406075397
+      },
+      {
+        id: 2781,
+        pass_round: 2782,
+        fail_round: nil,
+        start: nil,
+        title: 'my rb round',
+        type: 'random_draw',
+        start_date: 1406075397,
+        end_date: 1406085397
+      },
+      {
+        id: 2782,
+        pass_round: nil,
+        fail_round: nil,
+        start: nil,
+        title: 'my pf round',
+        type: 'prize_fulfillment',
+        start_date: 1406095398,
+        end_date: 1406105398
+      }
+    ],
+  entries_count: 1,
+  rounds_count: 3,
+  participants_count: 1
+}
+VALID_GAME_02 = {
+  id: 2677,
+  title: nil,
+  metadata: nil,
+  flow:
+  [
+    {
+      id: 2771,
+      pass_round: 2772,
+      fail_round: nil,
+      start: true,
+      title: 'my sub round',
+      type: 'submission',
+      start_date: 1406065391,
+      end_date: 1406075391
+    },
+    {
+      id: 2772,
+      pass_round: 2773,
+      fail_round: nil,
+      start: nil,
+      title: 'my rb round',
+      type: 'random_draw',
+      start_date: 1406075392,
+      end_date: 1406085392
+    },
+    {
+      id: 2773,
+      pass_round: nil,
+      fail_round: nil,
+      start: nil,
+      title: 'my pf round',
+      type: 'prize_fulfillment',
+      start_date: 1406095392,
+      end_date: 1406105392
+    }
+  ],
+  entries_count: 0,
+  rounds_count: 3,
+  participants_count: 1
+}
+GAME_INDEX = {
+  results: [VALID_GAME_01, VALID_GAME_02],
+  paging: {
+    min_id: VALID_GAME_01[:id],
+    max_id: VALID_GAME_02[:id],
+    next_max_id: VALID_GAME_01[:id] - 1
+  }
+}

data/spec/fixtures/judging_fixtures.rb

@@ -0,0 +1,72 @@
+JUDGING_GET_RESPONSE = {
+  round_id: 4444,
+  judging: [
+    {
+      judge_id: 55555,
+      judgments: [
+        {
+          id: 1234,
+          entry_id: 878787,
+          score: 3,
+          metadata: {
+            comments: 'This entry was very well designed.'
+          },
+          created: 1413889551
+        },
+        {
+          id: 1235,
+          entry_id: 878788,
+          score: 2,
+          metadata: {
+            comments: 'This entry was decent.'
+          },
+          created: 1413889599
+        },
+        {
+          id: 1236,
+          entry_id: 878789,
+          score: 1,
+          metadata: {
+            comments: 'This entry was third in my books.'
+          },
+          created: 1413889655
+        }
+      ]
+    },
+    {
+      judge_id: 55556,
+      judgments: [
+        {
+          id: 1237,
+          entry_id: 878788,
+          score: 3,
+          metadata: {
+            comments: 'This entry was excellent.'
+          },
+          created: 1413889551
+        },
+        {
+          id: 1238,
+          entry_id: 878789,
+          score: 2,
+          metadata: {
+            comments: 'This entry was relatively good.'
+          },
+          created: 1413889599
+        },
+        {
+          id: 1239,
+          entry_id: 878787,
+          score: 1,
+          metadata: {
+            comments: 'This entry half-hearted.'
+          },
+          created: 1413889655
+        }
+      ]
+    }
+  ]
+}
+JUDGING_RESPONSE = {
+  message: 'Judging was successful'
+}

data/spec/fixtures/moderation_fixtures.rb

@@ -0,0 +1,56 @@
+MODERATION_GET = {
+  results: [
+    {
+      id: 9898,
+      participant_id: 6767,
+      state: 1234,
+      metadata: {
+        image: 'http://placehold.it/350x150',
+        title: 'Image Entry',
+        description: 'This is a picture of my house'
+      }
+    },
+    {
+      id: 9899,
+      participant_id: 6767,
+      state: 1234,
+      metadata: {
+        image: 'http://placehold.it/350x150',
+        title: 'Image Entry #2',
+        description: 'This is another picture of my house'
+      }
+    },
+    {
+      id: 3322,
+      participant_id: 4433,
+      state: 3324,
+      metadata: {
+        title: 'Entry in state 3324'
+      }
+    },
+    {
+      id: 9899,
+      participant_id: 6767,
+      state: 3324,
+      metadata: {
+        title: 'Another Entry in state 3324'
+      }
+    }
+  ]
+}
+MODERATION_POST_RESPONSE = {
+  results: [
+    {
+      id: ENTRY_01[:id],
+      state: 444
+    },
+    {
+      id: ENTRY_02[:id],
+      state: 555
+    },
+    {
+      id: ENTRY_03[:id],
+      state: 555
+    }
+  ]
+}

data/spec/fixtures/participants_fixtures.rb

@@ -0,0 +1,43 @@
+PARTICIPANT_01 = {
+  id: 6738,
+  game_id: 3924,
+  metadata: nil,
+  name: nil,
+  email: 'test@test.com',
+  password: nil
+}
+PARTICIPANT_01_UPDATED = {
+  id: 6738,
+  game_id: 3924,
+  metadata: { age: 20 },
+  name: nil,
+  email: 'test@test.com',
+  password: nil
+}
+PARTICIPANT_02 = {
+  id: 6739,
+  game_id: 3924,
+  metadata: nil,
+  name: nil,
+  email: 'test123@test.com',
+  password: nil
+}
+PARTICIPANT_INDEX = [PARTICIPANT_01, PARTICIPANT_02]
+PARTICIPANT_TOKEN_RENEW = {
+  token: '3e9dsgskj32f8fj3fae0vfnsi217dnds',
+  token_expired: false
+}
+PARTICIPANT_PERMISSIONS = {
+  permissions: [
+    'api_basic',
+    'registered',
+    'administrate',
+    'moderate'
+  ]
+}
+PARTICIPANT_PERMISSIONS_UPDATED = {
+  permissions: [
+    'api_basic',
+    'registered'
+  ]
+}

data/spec/fixtures/points_fixtures.rb

@@ -0,0 +1,4 @@
+POINTS_RESPONSE = {
+  id: 76767,
+  weight: 5
+}

data/spec/fixtures/rounds_fixtures.rb

@@ -0,0 +1,68 @@
+SUBMISSION_ROUND = {
+  id: 4279,
+  title: 'my round',
+  start_date: 1406652331,
+  end_date: 1406655931,
+  type: 'submission',
+  rules: {
+    num_entries: 100,
+    interval: 'day'
+  }
+}
+SUBMISSION_ROUND_UPDATED = {
+  id: 4279,
+  title: 'updated',
+  start_date: 1406652331,
+  end_date: 1406655931,
+  type: 'submission',
+  rules: {
+    num_entries: 100,
+    interval: 'day'
+  }
+}
+RANDOM_DRAW_ROUND = {
+  id: 4279,
+  title: 'my random draw round',
+  start_date: 1406652331,
+  end_date: 1406655931,
+  type: 'random_draw',
+  rules: {
+    winners: 10,
+    percentage: false
+  }
+}
+PRIZE_FULFILLMENT_ROUND = {
+  id: 4279,
+  title: 'my prize fulfillment round',
+  start_date: 1406652331,
+  end_date: 1406655931,
+  type: 'webhook',
+  rules: {
+    webhook: 'http://www.strutta.com'
+  }
+}
+POINTS_ROUND = {
+  id: 4399,
+  title: 'my points round',
+  start_date: 1406652888,
+  end_date: 1406656999,
+  type: 'points',
+  rules: {
+    winners: 10,
+    interval: 'game',
+    min_allowed: 0,
+    max_allowed: 10
+  }
+}
+JUDGING_ROUND = {
+  id: 5532,
+  title: 'my judging round',
+  start_date: 1406652888,
+  end_date: 1406656999,
+  type: 'judging',
+  rules: {
+    winners: 10,
+    ranking_size: 5
+  }
+}
+ROUND_INDEX = [SUBMISSION_ROUND, RANDOM_DRAW_ROUND, PRIZE_FULFILLMENT_ROUND]

data/spec/flow_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(:flow_no_game) { strutta.games.flow }
+  let(:flow_params) do
+    {
+      definition: [
+        {
+          id: SUBMISSION_ROUND[:id],
+          pass_round: RANDOM_DRAW_ROUND[:id],
+          fail_round: nil,
+          start: true
+        },
+        {
+          id: RANDOM_DRAW_ROUND[:id],
+          pass_round: PRIZE_FULFILLMENT_ROUND[:id],
+          fail_round: nil
+        },
+        {
+          id: PRIZE_FULFILLMENT_ROUND[:id],
+          pass_round: nil,
+          fail_round: nil
+        }
+      ]
+    }
+  end
+  let(:flow) { game.flow.create(flow_params) }
+
+  describe 'games(:id).flow' do
+    context 'when no id is given' do
+
+      context '.get' do
+        before do
+          stub_request(:get, /.*flow/)
+           .to_return(status: 200, body: FLOW.to_json, headers: {})
+        end
+        it 'should return flow hash' do
+          f = game.flow.get
+          expect(f['flow'].is_a? Array).to be true
+        end
+      end
+
+      context '.delete' do
+        before do
+          stub_request(:delete, /.*flow/)
+           .to_return(status: 204, body: '', headers: {})
+        end
+        it 'should delete flow' do
+          expect(game.flow.delete).to be true
+        end
+      end
+
+      context '.create' do
+        context 'with valid parameters' do
+          before do
+            stub_request(:post, /.*flow/)
+             .to_return(status: 201, body: FLOW.to_json, headers: {})
+          end
+          it 'should return a new flow hash' do
+            expect(flow['flow'].is_a? Array).to be true
+            expect(flow['flow'].first['id']).to eq(SUBMISSION_ROUND[:id])
+          end
+        end
+      end
+
+      context '.update' do
+        it 'should throw error' do
+          expect { game.flow.update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.all' do
+        it 'should throw error' do
+          expect { game.flow.all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+    end
+
+    context 'when id is given' do
+      context '.get' do
+        it 'should throw error' do
+          expect { game.flow(1).get }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw error' do
+          expect { game.flow(1).delete }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.create' do
+        it 'should throw error' do
+          expect { game.flow(1).create(flow_params) }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.update' do
+        it 'should throw error' do
+          expect { game.flow(1).update({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+
+      context '.all' do
+        it 'should throw error' do
+          expect { game.flow(1).all({}) }.to raise_error(Strutta::Errors::DisabledEndpointError)
+        end
+      end
+    end
+  end
+end