chgk_rating 1.0.0.rc1 → 1.0.0

data/lib/chgk_rating/connection.rb

@@ -1,19 +1,19 @@
-module ChgkRating
-  module Connection
-    BASE_URL = 'http://rating.chgk.info/api'.freeze
-
-    def connection
-      options = {
-          headers: {
-              accept: 'application/json',
-              user_agent: "chgk_rating ruby gem/#{ChgkRating::VERSION}"
-          },
-          url: BASE_URL + '/'
-      }
-
-      Faraday.new options do |faraday|
-        faraday.adapter Faraday.default_adapter
-      end
-    end
-  end
+module ChgkRating
+  module Connection
+    BASE_URL = 'http://rating.chgk.info/api'.freeze
+
+    def connection
+      options = {
+          headers: {
+              accept: 'application/json',
+              user_agent: "chgk_rating ruby gem/#{ChgkRating::VERSION}"
+          },
+          url: BASE_URL + '/'
+      }
+
+      Faraday.new options do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
 end

data/lib/chgk_rating/error.rb

@@ -1,46 +1,46 @@
-module ChgkRating
-  class Error < StandardError
-    ClientError = Class.new(self)
-    ServerError = Class.new(self)
-
-    EagerLoadingNotSupported = Class.new(ClientError) do
-      def to_s
-        'Eager loading is not supported for this resource.'
-      end
-    end
-
-    NotHashType = Class.new(ClientError) do
-      def to_s
-        'This is not a hash-like collection, so it cannot be converted to an ordinary hash.'
-      end
-    end
-
-    NotArrayType = Class.new(ClientError) do
-      def to_s
-        'This is not an array-like collection, so it cannot be converted to an ordinary array.'
-      end
-    end
-
-    BadRequest = Class.new(ServerError)
-    NotFound = Class.new(ServerError)
-    NotImplemented = Class.new(ServerError)
-
-    ERRORS = {
-        400 => ChgkRating::Error::BadRequest,
-        404 => ChgkRating::Error::NotFound,
-        501 => ChgkRating::Error::NotImplemented
-    }
-
-    class << self
-      # Create a new error from an HTTP response
-      def from_response(body)
-        new(body.to_s)
-      end
-    end
-
-    # Initializes a new Error object
-    def initialize(message = '')
-      super(message)
-    end
-  end
+module ChgkRating
+  class Error < StandardError
+    ClientError = Class.new(self)
+    ServerError = Class.new(self)
+
+    EagerLoadingNotSupported = Class.new(ClientError) do
+      def to_s
+        'Eager loading is not supported for this resource.'
+      end
+    end
+
+    NotHashType = Class.new(ClientError) do
+      def to_s
+        'This is not a hash-like collection, so it cannot be converted to an ordinary hash.'
+      end
+    end
+
+    NotArrayType = Class.new(ClientError) do
+      def to_s
+        'This is not an array-like collection, so it cannot be converted to an ordinary array.'
+      end
+    end
+
+    BadRequest = Class.new(ServerError)
+    NotFound = Class.new(ServerError)
+    NotImplemented = Class.new(ServerError)
+
+    ERRORS = {
+        400 => ChgkRating::Error::BadRequest,
+        404 => ChgkRating::Error::NotFound,
+        501 => ChgkRating::Error::NotImplemented
+    }
+
+    class << self
+      # Create a new error from an HTTP response
+      def from_response(body)
+        new(body.to_s)
+      end
+    end
+
+    # Initializes a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
 end

data/lib/chgk_rating/models/base.rb

@@ -1,90 +1,90 @@
-module ChgkRating
-  module Models
-    class Base < ChgkObject
-      include ChgkRating::Request
-
-      attr_reader :lazy
-
-      def self.inherited(subclass)
-        attr_reader(*subclass.attribute_mapping.keys) if subclass.attribute_mapping
-        super
-      end
-
-      def initialize(id_or_hash, params = {})
-        raw = raw_by id_or_hash, lazy_load?(params)
-
-        # If we only have an ID and `lazy` is set to true, then simply store this ID
-        # Otherwise extract all data from the hash
-        raw.nil? ? @id = id_or_hash : extract_from(raw)
-
-        @lazy = (params[:lazy] || false) unless self.class.const_defined?(:NO_LAZY_SUPPORT)
-      end
-
-      # Load data from API if the resource was initially lazily loaded.
-      # Set `force` to reload data even if it is already present.
-      def eager_load!(force = false)
-        return unless @lazy || force
-        extract_from raw_by(self.id)
-        @lazy = false
-        self
-      end
-
-      def self.no_eager_loading!
-        define_method :eager_load! do |*_args|
-          raise ChgkRating::Error::EagerLoadingNotSupported
-        end
-      end
-
-      def self.no_lazy_support!
-        self.const_set :NO_LAZY_SUPPORT, true
-        undef_method :lazy
-      end
-
-      def to_h
-        self.class.attribute_mapping.inject({}) do |memo, (attr, mapping)|
-          data = self.send attr
-          data = mapping[:transform_down].call(data) if mapping.has_key?(:transform_down)
-          memo[ mapping[:raw_name] ] = data
-          memo
-        end
-      end
-
-      private
-
-      def self.attribute_mapping
-        return nil unless self.name
-        ChgkRating::AttributeMappings.find self.name
-      end
-
-      def lazy_load?(params)
-        self.class.const_defined?(:NO_LAZY_SUPPORT) ? false : params[:lazy]
-      end
-
-      # If the `object` is a `String` or `Integer` - that's an id.
-      # If `lazy` is not set to `true` we need to perform an API request.
-      # If `lazy` is set to `true` - do nothing,
-      # we are going to only save this ID.
-      # If the `object` is not a `String` or `Integer`, it already has all the necessary information and
-      # so we simply create a new instance of the class using it.
-      def raw_by(object, lazy = false)
-        return object unless object.is_a?(String) || object.is_a?(Integer) || object.is_a?(Symbol)
-        return nil if lazy
-
-        get_result_by object
-      end
-
-      def get_result_by(object)
-        result = get "#{api_path}/#{object}"
-        result.is_a?(Array) ? result.first : result
-      end
-
-      def extract_from(raw_data)
-        self.class.attribute_mapping.each do |attr, mapping|
-          data = raw_data.is_a?(self.class) ? raw_data.send(attr) : raw_data[ mapping[:raw_name] ]
-          data = mapping[:transform_up].call(data) if mapping.has_key?(:transform_up)
-          instance_variable_set "@#{attr}", data
-        end
-      end
-    end
-  end
+module ChgkRating
+  module Models
+    class Base < ChgkObject
+      include ChgkRating::Request
+
+      attr_reader :lazy
+
+      def self.inherited(subclass)
+        attr_reader(*subclass.attribute_mapping.keys) if subclass.attribute_mapping
+        super
+      end
+
+      def initialize(id_or_hash, params = {})
+        raw = raw_by id_or_hash, lazy_load?(params)
+
+        # If we only have an ID and `lazy` is set to true, then simply store this ID
+        # Otherwise extract all data from the hash
+        raw.nil? ? @id = id_or_hash : extract_from(raw)
+
+        @lazy = (params[:lazy] || false) unless self.class.const_defined?(:NO_LAZY_SUPPORT)
+      end
+
+      # Load data from API if the resource was initially lazily loaded.
+      # Set `force` to reload data even if it is already present.
+      def eager_load!(force = false)
+        return unless @lazy || force
+        extract_from raw_by(self.id)
+        @lazy = false
+        self
+      end
+
+      def self.no_eager_loading!
+        define_method :eager_load! do |*_args|
+          raise ChgkRating::Error::EagerLoadingNotSupported
+        end
+      end
+
+      def self.no_lazy_support!
+        self.const_set :NO_LAZY_SUPPORT, true
+        undef_method :lazy
+      end
+
+      def to_h
+        self.class.attribute_mapping.inject({}) do |memo, (attr, mapping)|
+          data = self.send attr
+          data = mapping[:transform_down].call(data) if mapping.has_key?(:transform_down)
+          memo[ mapping[:raw_name] ] = data
+          memo
+        end
+      end
+
+      private
+
+      def self.attribute_mapping
+        return nil unless self.name
+        ChgkRating::AttributeMappings.find self.name
+      end
+
+      def lazy_load?(params)
+        self.class.const_defined?(:NO_LAZY_SUPPORT) ? false : params[:lazy]
+      end
+
+      # If the `object` is a `String` or `Integer` - that's an id.
+      # If `lazy` is not set to `true` we need to perform an API request.
+      # If `lazy` is set to `true` - do nothing,
+      # we are going to only save this ID.
+      # If the `object` is not a `String` or `Integer`, it already has all the necessary information and
+      # so we simply create a new instance of the class using it.
+      def raw_by(object, lazy = false)
+        return object unless object.is_a?(String) || object.is_a?(Integer) || object.is_a?(Symbol)
+        return nil if lazy
+
+        get_result_by object
+      end
+
+      def get_result_by(object)
+        result = get "#{api_path}/#{object}"
+        result.is_a?(Array) ? result.first : result
+      end
+
+      def extract_from(raw_data)
+        self.class.attribute_mapping.each do |attr, mapping|
+          data = raw_data.is_a?(self.class) ? raw_data.send(attr) : raw_data[ mapping[:raw_name] ]
+          data = mapping[:transform_up].call(data) if mapping.has_key?(:transform_up)
+          instance_variable_set "@#{attr}", data
+        end
+      end
+    end
+  end
 end

data/lib/chgk_rating/models/player.rb

@@ -1,11 +1,11 @@
-module ChgkRating
-  module Models
-    class Player < Base
-      private
-
-      def api_path
-        'players'
-      end
-    end
-  end
+module ChgkRating
+  module Models
+    class Player < Base
+      private
+
+      def api_path
+        'players'
+      end
+    end
+  end
 end

data/lib/chgk_rating/models/rating.rb

@@ -1,19 +1,19 @@
-module ChgkRating
-  module Models
-    class Rating < Base
-      no_eager_loading!
-      no_lazy_support!
-
-      def initialize(release_id_or_hash, params = {})
-        @team_id = extract_id_from params[:team]
-        super
-      end
-
-      private
-
-      def api_path
-        "teams/#{@team_id}/rating"
-      end
-    end
-  end
+module ChgkRating
+  module Models
+    class Rating < Base
+      no_eager_loading!
+      no_lazy_support!
+
+      def initialize(release_id_or_hash, params = {})
+        @team_id = extract_id_from params[:team]
+        super
+      end
+
+      private
+
+      def api_path
+        "teams/#{@team_id}/rating"
+      end
+    end
+  end
 end

data/lib/chgk_rating/models/recap.rb

@@ -1,19 +1,19 @@
-module ChgkRating
-  module Models
-    class Recap < Base
-      no_eager_loading!
-      no_lazy_support!
-
-      def initialize(season_id_or_hash, params = {})
-        @team_id = extract_id_from params[:team]
-        super
-      end
-
-      private
-
-      def api_path
-        "teams/#{@team_id}/recaps"
-      end
-    end
-  end
+module ChgkRating
+  module Models
+    class Recap < Base
+      no_eager_loading!
+      no_lazy_support!
+
+      def initialize(season_id_or_hash, params = {})
+        @team_id = extract_id_from params[:team]
+        super
+      end
+
+      private
+
+      def api_path
+        "teams/#{@team_id}/recaps"
+      end
+    end
+  end
 end

data/lib/chgk_rating/models/team.rb

@@ -1,62 +1,62 @@
-module ChgkRating
-  module Models
-    class Team < Base
-      # Returns a single Recap for the current Team at a given season
-      #
-      # @raise [ChgkRating::Error::BadRequest] Error raised when the requested season is invalid
-      # @return [ChgkRating::Models::Recap] The requested Recap.
-      # @param season_id [String or Integer] Season to load recap for.
-      def recap(season_id)
-        ChgkRating::Models::Recap.new season_id, team: self
-      end
-
-      # Returns TournamentTeam for the current Team at a given tournament
-      #
-      # @raise [ChgkRating::Error::NotFound] Error raised when the requested Tournament cannot be found.
-      # @return [ChgkRating::Models::TournamentTeam] The requested TournamentTeam.
-      # @param tournament_or_id [String, Integer or Tournament] Tournament to load the team for
-      def at_tournament(tournament_or_id)
-        ChgkRating::Models::TournamentTeam.new self, tournament: tournament_or_id, lazy: true
-      end
-
-      # Returns Rating for the current Team in a given release
-      #
-      # @return [ChgkRating::Models::Rating] The requested Rating.
-      # @param release_id [String or Integer] Release to load rating for.
-      def rating(release_id)
-        ChgkRating::Models::Rating.new release_id, team: self
-      end
-
-      # Returns an array-like Ratings collection for the current team.
-      #
-      # @return [ChgkRating::Collection::Ratings] The collection of ratings.
-      def ratings
-        ChgkRating::Collections::Ratings.new team: self
-      end
-
-      # Returns an hash-like Recaps collection for the current team, grouped by seasons. Seasons act
-      # as keys, whereas Recap models - as values.
-      #
-      # @return [ChgkRating::Collection::Recaps] The collection of recaps.
-      def recaps
-        ChgkRating::Collections::Recaps.new team: self
-      end
-
-      # Returns a collection of Tournaments that the current team participated at based on the given criteria
-      #
-      # @raise [ChgkRating::Error::NotFound] Error raised when nothing can be found based on the given criteria.
-      # @return [ChgkRating::Collection::Tournaments] The collection of tournaments.
-      # @param season_id [String or Integer] Season to load tournaments for
-      # @option params [String or Integer] :page The requested page. Default is 1
-      def tournaments(season_id: nil, params: {})
-        ChgkRating::Collections::Tournaments.new params.merge team: self, season_id: season_id, lazy: true
-      end
-
-      private
-
-      def api_path
-        'teams'
-      end
-    end
-  end
+module ChgkRating
+  module Models
+    class Team < Base
+      # Returns a single Recap for the current Team at a given season
+      #
+      # @raise [ChgkRating::Error::BadRequest] Error raised when the requested season is invalid
+      # @return [ChgkRating::Models::Recap] The requested Recap.
+      # @param season_id [String or Integer] Season to load recap for.
+      def recap(season_id)
+        ChgkRating::Models::Recap.new season_id, team: self
+      end
+
+      # Returns TournamentTeam for the current Team at a given tournament
+      #
+      # @raise [ChgkRating::Error::NotFound] Error raised when the requested Tournament cannot be found.
+      # @return [ChgkRating::Models::TournamentTeam] The requested TournamentTeam.
+      # @param tournament_or_id [String, Integer or Tournament] Tournament to load the team for
+      def at_tournament(tournament_or_id)
+        ChgkRating::Models::TournamentTeam.new self, tournament: tournament_or_id, lazy: true
+      end
+
+      # Returns Rating for the current Team in a given release
+      #
+      # @return [ChgkRating::Models::Rating] The requested Rating.
+      # @param release_id [String or Integer] Release to load rating for.
+      def rating(release_id)
+        ChgkRating::Models::Rating.new release_id, team: self
+      end
+
+      # Returns an array-like Ratings collection for the current team.
+      #
+      # @return [ChgkRating::Collection::Ratings] The collection of ratings.
+      def ratings
+        ChgkRating::Collections::Ratings.new team: self
+      end
+
+      # Returns an hash-like Recaps collection for the current team, grouped by seasons. Seasons act
+      # as keys, whereas Recap models - as values.
+      #
+      # @return [ChgkRating::Collection::Recaps] The collection of recaps.
+      def recaps
+        ChgkRating::Collections::Recaps.new team: self
+      end
+
+      # Returns a collection of Tournaments that the current team participated at based on the given criteria
+      #
+      # @raise [ChgkRating::Error::NotFound] Error raised when nothing can be found based on the given criteria.
+      # @return [ChgkRating::Collection::Tournaments] The collection of tournaments.
+      # @param season_id [String or Integer] Season to load tournaments for
+      # @option params [String or Integer] :page The requested page. Default is 1
+      def tournaments(season_id: nil, params: {})
+        ChgkRating::Collections::Tournaments.new params.merge team: self, season_id: season_id, lazy: true
+      end
+
+      private
+
+      def api_path
+        'teams'
+      end
+    end
+  end
 end