strutta-api 1.0.1

data/lib/strutta-api/judging.rb

@@ -0,0 +1,29 @@
+module Strutta
+  # Entries belong to a Strutta::Games object
+  # Instance methods found in Strutta::APIObject
+  class Judging < APIObject
+    # Initializes the Strutta::Entries object
+    #
+    # @param id [Integer, nil] Entry id
+    # @param game [Strutta::Games] Master Strutta::Games object
+    # @return [Strutta::Points] instantiated Strutta::Points object
+    def initialize(id = nil, game)
+      @id = id
+      @game = game
+      @root_path = 'judging'
+    end
+
+    # GET request for Judging (no ID required)
+    #
+    # @return [Hash] Parsed body of the API response
+    def get(params = {})
+      @game.verify_no_id(@id)
+      @game.get(params, @root_path)
+    end
+
+    # Disbled methods
+    alias_method :all, :method_disabled
+    alias_method :update, :method_disabled
+    alias_method :delete, :method_disabled
+  end
+end

data/lib/strutta-api/moderation.rb

@@ -0,0 +1,29 @@
+module Strutta
+  # Entries belong to a Strutta::Games object
+  # Instance methods found in Strutta::APIObject
+  class Moderation < APIObject
+    # Initializes the Strutta::Entries object
+    #
+    # @param id [Integer, nil] Entry id
+    # @param game [Strutta::Games] Master Strutta::Games object
+    # @return [Strutta::Points] instantiated Strutta::Points object
+    def initialize(id = nil, game)
+      @id = id
+      @game = game
+      @root_path = 'moderation'
+    end
+
+    # GET request for Moderation (no ID required)
+    #
+    # @return [Hash] Parsed body of the API response
+    def get(params = {})
+      @game.verify_no_id(@id)
+      @game.get(params, @root_path)
+    end
+
+    # Disbled methods
+    alias_method :all, :method_disabled
+    alias_method :update, :method_disabled
+    alias_method :delete, :method_disabled
+  end
+end

data/lib/strutta-api/participants.rb

@@ -0,0 +1,60 @@
+module Strutta
+  # Participants belong to a Strutta::Games object
+  # Instance methods found in Strutta::APIObject
+  class Participants < APIObject
+    # Initializes the Strutta::Participants object
+    #
+    # @param id [Integer, nil] Entry id
+    # @param game [Strutta::Games] Master Strutta::Games object
+    # @return [Strutta::Participants] instantiated Strutta::Participants object
+    def initialize(id = nil, game)
+      @id = id
+      @game = game
+      @root_path = "participants/#{@id}"
+      @no_id_error = Errors::PARTICIPANT_ID_REQUIRED
+    end
+
+    # GET participant by email address
+    # games/:game_id/participants/search
+    #
+    # @return [Hash] Parsed body of the API response
+    def search(params)
+      fail Errors::InvalidSearchParameters, Errors::INVALID_SEARCH unless params.key? :email
+      @game.verify_no_id(@id)
+      @game.get(params, 'participants/search')
+    end
+
+    # PATCH update Participant token
+    # games/:game_id/participants/:id/token
+    #
+    # @return [Hash] Parsed body of the API response
+    def token_renew(params = {})
+      participant_id_required
+      @game.update(params, "participants/#{@id}/token")
+    end
+
+    # GET participant permissions
+    # games/:game_id/participants/:id/permissions
+    #
+    # @return [Hash] Parsed body of the API response
+    def permissions(params = {})
+      participant_id_required
+      @game.get(params, "participants/#{@id}/permissions")
+    end
+
+    # PATCH participant permissions
+    # games/:game_id/participants/:id/permissions
+    #
+    # @return [Hash] Parsed body of the API response
+    def permissions_update(params = {})
+      participant_id_required
+      @game.update(params, "participants/#{@id}/permissions")
+    end
+
+    private
+
+    def participant_id_required
+      @game.verify_id(@id, Errors::PARTICIPANT_ID_REQUIRED)
+    end
+  end
+end

data/lib/strutta-api/points.rb

@@ -0,0 +1,22 @@
+module Strutta
+  # Entries belong to a Strutta::Games object
+  # Instance methods found in Strutta::APIObject
+  class Points < APIObject
+    # Initializes the Strutta::Entries object
+    #
+    # @param id [Integer, nil] Entry id
+    # @param game [Strutta::Games] Master Strutta::Games object
+    # @return [Strutta::Points] instantiated Strutta::Points object
+    def initialize(id = nil, game)
+      @id = id
+      @game = game
+      @root_path = 'points'
+    end
+
+    # Disbled methods
+    alias_method :all, :method_disabled
+    alias_method :get, :method_disabled
+    alias_method :update, :method_disabled
+    alias_method :delete, :method_disabled
+  end
+end

data/lib/strutta-api/rounds.rb

@@ -0,0 +1,17 @@
+module Strutta
+  # Rounds belong to a Strutta::Games object
+  # Instance methods found in Strutta::APIObject
+  class Rounds < APIObject
+    # Initializes the Strutta::Rounds object
+    #
+    # @param id [Integer, nil] Entry id
+    # @param game [Strutta::Games] Master Strutta::Games object
+    # @return [Strutta::Rounds] instantiated Strutta::Rounds object
+    def initialize(id = nil, game)
+      @id = id
+      @game = game
+      @root_path = "rounds/#{@id}"
+      @no_id_error = Errors::ROUND_ID_REQUIRED
+    end
+  end
+end

data/lib/strutta-api/version.rb

@@ -0,0 +1,9 @@
+module Strutta
+  # Strutta Wrapper Version Info
+  module Version
+    # This wrapper's version
+    VERSION = '1.0.1'
+    # This path association with this version
+    VERSION_PATH = '/v1/'
+  end
+end

data/spec/entries_spec.rb

@@ -0,0 +1,168 @@
+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 }
+
+  describe 'games(:id).entries' do
+    context 'when no id is given' do
+      context '.get' do
+        it 'should throw error' do
+          expect { strutta.games.entries.get }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.update' do
+        it 'should throw error' do
+          expect { strutta.games.entries.update(title: 'title') }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.delete' do
+        it 'should throw error' do
+          expect { strutta.games.entries.delete }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.transitions' do
+        it 'should throw error' do
+          expect { strutta.games.entries.transitions }.to raise_error(Strutta::Errors::ObjectIDRequired)
+        end
+      end
+
+      context '.all' do
+        before do
+          stub_request(:get, /.*entries/)
+            .to_return(status: 200, body: ENTRY_INDEX.to_json, headers: {})
+        end
+        it 'should return array of entries' do
+          entries = strutta.games(VALID_GAME_01[:id]).entries.all
+          results = entries['results']
+          expect(results.is_a? Array).to be true
+        end
+
+        context 'when state is passed' do
+          before do
+            stub_request(:get, /.*entries/)
+              .with(body: hash_including(state: 111))
+              .to_return(status: 200, body: ENTRY_INDEX.to_json, headers: {})
+          end
+          it 'should return entries with that state' do
+            entries = strutta.games(VALID_GAME_01[:id]).entries.all(state: 111)
+            results = entries['results']
+            expect(results.is_a? Array).to be true
+          end
+        end
+
+        context 'when participant is passed' do
+          before do
+            stub_request(:get, /.*entries/)
+              .to_return(status: 200, body: ENTRY_INDEX.to_json, headers: {})
+          end
+          it 'should return entries with that state' do
+            entries = strutta.games(VALID_GAME_01[:id]).entries.all(participant: SUBMISSION_ROUND[:id])
+            results = entries['results']
+            expect(results.is_a? Array).to be true
+          end
+        end
+      end
+
+      context '.leaderboard' do
+        before do
+          stub_request(:get, /.*entries\/leaderboard/)
+            .to_return(status: 200, body: ENTRY_LEADERBOARD.to_json, headers: {})
+        end
+        it 'should return a leaderboard of entries' do
+          leaderboard = strutta.games(VALID_GAME_01[:id]).entries.leaderboard
+          results = leaderboard['results']
+          expect(results.is_a? Array).to be true
+          expect(leaderboard['paging']['top_rank'].is_a? Integer).to be true
+        end
+      end
+
+      context '.create' do
+        context 'with valid parameters' do
+          before do
+            stub_request(:post, /.*entries/)
+             .to_return(status: 201, body: ENTRY_01.to_json, headers: {})
+          end
+          it 'should return a new entry hash' do
+            entry = strutta.games(VALID_GAME_01[:id]).entries.create(participant: PARTICIPANT_01[:id])
+            expect(entry['id']).to_not be nil
+          end
+        end
+      end
+    end
+
+    context 'when id is given' do
+      context '.get' do
+        before do
+          stub_request(:get, /.*entries\/\d+/)
+           .to_return(status: 200, body: ENTRY_01.to_json, headers: {})
+        end
+        it 'should return entry hash' do
+          e = strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).get
+          expect(e['id']).to_not be nil
+        end
+      end
+
+      context '.update' do
+        before do
+          stub_request(:patch, /.*entries\/\d+/)
+           .to_return(status: 200, body: ENTRY_01_UPDATED.to_json, headers: {})
+        end
+        it 'should return updated entry hash' do
+          metadata = { age: 20 }
+          updated = strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).update(metadata: metadata)
+          expect(updated['metadata']['age']).to eq(20)
+        end
+      end
+
+      context '.delete' do
+        before do
+          stub_request(:delete, /.*entries\/\d+/)
+           .to_return(status: 204, body: '', headers: {})
+        end
+        it 'should delete entry' do
+          expect(strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).delete).to be true
+        end
+      end
+
+      context '.transitions' do
+        before do
+          stub_request(:get, %r{.*entries\/\d+\/transitions})
+           .to_return(status: 200, body: ENTRY_TRANSITIONS.to_json, headers: {})
+        end
+        it 'should get list of entry transitions' do
+          body = strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).transitions
+          expect(body['transitions'].is_a? Array).to be true
+          expect(body['transitions'].first['from'].is_a? Integer).to be true
+        end
+      end
+
+      context '.all' do
+        it 'should throw error' do
+          expect { strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).all }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.leaderboard' do
+        it 'should throw error' do
+          expect { strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).leaderboard }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+
+      context '.create' do
+        it 'should throw error' do
+          expect { strutta.games(VALID_GAME_01[:id]).entries(ENTRY_01[:id]).create(email: 'my@email.com') }.to raise_error(Strutta::Errors::ObjectIDNotAllowed)
+        end
+      end
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -0,0 +1,55 @@
+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 }
+
+  describe 'Errors' do
+    before do
+      stub_request(:get, /.*games/)
+       .to_return(status: 401, body: '{}', headers: {})
+    end
+    context 'when token is invalid' do
+      it 'should throw Unauthorized error' do
+        invalid_strutta = Strutta::API.new 'not_a_token', host, path
+        expect { invalid_strutta.games.all }.to raise_error(Strutta::Errors::Unauthorized)
+      end
+    end
+
+    context 'when object does not exist' do
+      before do
+        stub_request(:get, /.*games\/\d+/)
+         .to_return(status: 404, body: '{}', headers: {})
+      end
+      it 'should throw ObjectNotFoundError error' do
+        expect { strutta.games(345).get }.to raise_error(Strutta::Errors::ObjectNotFoundError)
+      end
+    end
+
+    context 'when parameters are missing' do
+      before do
+        stub_request(:post, %r{.*games\/\d+\/rounds})
+         .to_return(status: 422, body: '{}', headers: {})
+      end
+      it 'should throw UnprocessableEntityError error' do
+        expect { strutta.games(VALID_GAME_01[:id]).rounds.create(type: 'submission') }.to raise_error(Strutta::Errors::UnprocessableEntityError)
+      end
+    end
+
+    context 'when parameters are missing' do
+      before do
+        stub_request(:post, %r{.*games\/\d+\/rounds})
+         .to_return(status: 400, body: '{}', headers: {})
+      end
+      it 'should throw BadRequestError error' do
+        expect { strutta.games(VALID_GAME_01[:id]).rounds.create(type: 'not_a_type') }.to raise_error(Strutta::Errors::BadRequestError)
+      end
+    end
+  end
+end

data/spec/fixtures/entries_fixtures.rb

@@ -0,0 +1,64 @@
+ENTRY_01 = {
+  id: 6191,
+  game_id: 3922,
+  metadata: {
+    title: 'My entry'
+  },
+  state: 4281,
+  participant: 6736,
+  points: 111,
+  rank: 3
+}
+ENTRY_01_UPDATED = {
+  id: 6191,
+  game_id: 3922,
+  metadata: {
+    age: 20
+  },
+  state: 4281,
+  participant: 6736
+}
+ENTRY_02 = {
+  id: 6192,
+  game_id: 3922,
+  metadata: {
+    title: 'My entry 2'
+  },
+  state: 4281,
+  participant: 6736,
+  points: 222,
+  rank: 2
+}
+ENTRY_03 = {
+  id: 6193,
+  game_id: 3922,
+  metadata: {
+    title: 'My entry 3'
+  },
+  state: 4281,
+  participant: 6736,
+  points: 333,
+  rank: 1
+}
+ENTRY_TRANSITIONS = {
+  transitions: [
+    { from: 555, to: 666 },
+    { from: 666, to: 777 }
+  ]
+}
+ENTRY_INDEX = {
+  results: [ENTRY_01, ENTRY_02, ENTRY_03],
+  paging: {
+    min_id: ENTRY_01[:id],
+    max_id: ENTRY_03[:id],
+    min_id: ENTRY_01[:id] - 1
+  }
+}
+ENTRY_LEADERBOARD = {
+  results: [ENTRY_01, ENTRY_02, ENTRY_03],
+  paging: {
+    top_rank: ENTRY_03[:rank],
+    bottom_rank: ENTRY_01[:rank],
+    next_top_rank: ENTRY_01[:rank] + 1
+  }
+}