unchained 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d440ea525f7c18793f4604906a9c1eb098e70b87
-  data.tar.gz: 1d5c9f43267ca976c652ffb615a8d12d5e315a5b
+  metadata.gz: 8a4a2a58f8403c47f9d8f1f45cef8df674462f7f
+  data.tar.gz: eecb1fc22ce12a1150efdfb27f3ce83df34cfe18
 SHA512:
-  metadata.gz: 1acaf1d610b637280ddf66f456b54e70acf1833307840c0f1142e3d83c6f1e97c8165fc3210841bcd22cf2b1308feed77eedb8d96ce1766de99a8d251a6cb002
-  data.tar.gz: ef53adfdcc531a92902ac9913bcb24599edfdaaa8c245884226eb26dd0f146056777d068fb6f8b4bc160be49ec85d55df760004df4aeea067a45af26f9e85c10
+  metadata.gz: 4473fade28915ab541388879834f05d92c7bca0694d5eb3d6a12d9d0f74e2c98d0fd1b408a08ec56125b5ecdb667a4f2c3fc11e2145a9653c9cf6b1fee548d9f
+  data.tar.gz: 4889219e809cf2a40f5985c8e8fd7aa8f46d9476118ccf5f42d0624b2fe1f30fadeea69b8e1913aaa5bb2f636c1ff375bdcc815a9f1a4b69557536eeff52af4e

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Andrew Thorp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+### Unchained
+
+A ruby client library for the Camelot Unchained API.
+
+You can view the API documentation at http://api.camelotunchained.com/
+
+### Usage
+
+First, install the gem:
+
+```ruby
+gem install unchained
+```
+
+Alternatively, add the gem to your Gemfile:
+
+```ruby
+gem 'unchained'
+```
+
+Once you have the gem installed, you can use it to interact with the Camelot
+Unchained API:
+
+```ruby
+[1] pry(main)> client = Unchained::Client.new;
+[2] pry(main)> client.servers.first
+=> #<Unchained::Client::Servers::Server:0x007fa0b94c7258 @access_level=6, @channel_id=4, @host="wyrmlingprep.camelotunchained.com", @name="WyrmlingPrep", @player_maximum=1000, @shard_id=1>
+```
+
+### TODO
+
+- Tests
+- Implement `loginToken` endpoints
+
+### License
+
+View the [License](LICENSE.md)
+

data/lib/unchained/client.rb

@@ -4,7 +4,9 @@ require_relative 'request'
 # RESOURCES
 require_relative 'client/mixins/resource'
 require_relative 'client/archetypes'
+require_relative 'client/attributes'
 require_relative 'client/factions'
+require_relative 'client/motd'
 require_relative 'client/races'
 require_relative 'client/patcher'
 require_relative 'client/servers'
@@ -28,7 +30,9 @@ module Unchained
 
     # RESOURCES
     include Unchained::Client::Archetypes
+    include Unchained::Client::Attributes
     include Unchained::Client::Factions
+    include Unchained::Client::MOTD
     include Unchained::Client::Races
     include Unchained::Client::Patcher
     include Unchained::Client::Servers

data/lib/unchained/client/archetypes.rb

@@ -4,12 +4,11 @@ module Unchained
 
       class Archetype
         include Unchained::Client::Mixins::Resource
-        resource({
-          :description => 'description',
-          :faction => 'faction',
-          :id => 'id',
-          :name => 'name',
-        })
+
+        attribute :description, String
+        attribute :faction, Integer
+        attribute :id, Integer
+        attribute :name, String
       end
 
       def archetypes(opts={})

data/lib/unchained/client/attributes.rb

@@ -0,0 +1,35 @@
+module Unchained
+  class Client
+    module Attributes
+
+      class AttributeInfo
+        include Unchained::Client::Mixins::Resource
+
+        attribute :base_value, Float, json: 'baseValue'
+        attribute :derived_from, String, json: 'derivedFrom'
+        attribute :description, String
+        attribute :max_or_multipler, Float, json: 'maxOrMultipler'
+        attribute :name, String
+        attribute :type, Integer
+        attribute :units, String
+      end
+
+      class AttributeOffset
+        include Unchained::Client::Mixins::Resource
+
+        attribute :race, Integer
+        attribute :gender, Integer
+        attribute :offsets, Hash, json: 'attributeOffsets'
+      end
+
+      def attributes(shard, opts={})
+        get_resources("#{base_url}/gamedata/attributes/#{shard}", AttributeInfo, opts)
+      end
+
+      def attribute_offsets(shard, opts={})
+        get_resources("#{base_url}/gamedata/attributeoffsets/#{shard}", AttributeOffset, opts)
+      end
+
+    end
+  end
+end

data/lib/unchained/client/factions.rb

@@ -4,12 +4,11 @@ module Unchained
 
       class Faction
         include Unchained::Client::Mixins::Resource
-        resource({
-          :description => 'description',
-          :id => 'id',
-          :name => 'name',
-          :short_name => 'shortName',
-        })
+
+        attribute :description, String
+        attribute :id, Integer
+        attribute :name, String
+        attribute :short_name, String, json: 'shortName'
       end
 
       def factions(opts={})

data/lib/unchained/client/mixins/resource.rb

@@ -1,41 +1,135 @@
 module Unchained
   class Client
     module Mixins
+
+      # The Resource mixin gives you access to a DSL that lets you define what
+      # the class should look like in the JSON response.
+      #
+      # Usage:
+      #
+      #   class Guild
+      #     include Unchained::Client::Mixins::Resource
+      #
+      #     attribute :id, String
+      #     attribute :name, String
+      #     attribute :members, Integer, json: 'numberOfMembers'
+      #   end
+      #
+
       module Resource
+
+        # An `Attribute` is what `attribute` creates.
+        class Attribute
+          attr_reader :name
+          attr_reader :type
+          attr_reader :opts
+
+          def initialize(name, type, opts)
+            @name = name
+            @type = type
+            @opts = opts
+          end
+
+          # The field that maps to this attribute in the JSON.
+          #
+          # Usage:
+          #
+          #   # json_field will return 'FOO'
+          #   attribute :foo, json: 'FOO'
+          #
+          #   # json_field will return 'foo_bar'
+          #   attribute :foo_bar
+          #
+          def json_field
+            @opts.fetch(:json, @name.to_s)
+          end
+
+          # Whether or not to allow nil, defaults to false.
+          def allow_nil?
+            @opts.fetch(:allow_nil, false)
+          end
+        end
+
         def self.included(base)
           base.extend ClassMethods
         end
 
+        # Mostly just a helper method that you can override if you
+        # want to.
         def to_s
-          attributes = self.class::JSON_MAP.map{|k,_| "#{k}=#{self.send(k)}"}.join(" ")
-          "[#{self.class_name}] #{attributes}"
-        end
+          attrs = self.class.attributes.map do |attr|
+            "#{attr.name}=#{self.send(attr.name)}"
+          end.join(', ')
 
-        # Lurk, is there not a better way to do this?
-        def class_name
-          self.class.name.split('::').last
+          "[#{self.class.name.split('::').last}] #{attrs}"
         end
 
         module ClassMethods
-          JSON_MAP = {}
+          attr_reader :attributes
 
-          def resource(json_map)
+          def attribute(name, type, opts={})
             instance_eval do
-              const_set("JSON_MAP", json_map)
+              attr_accessor name
             end
 
-            class_eval do
-              attr_accessor(*json_map.keys)
+            @attributes ||= []
+            @attributes << Attribute.new(name, type, opts)
+          end
+
+          # This is a pretty naive implementation of parsing JSON. It will
+          # loop through all of `@attributes` to find the right one, then do
+          # some very minimal validation, before setting the attribute on the
+          # instance.
+          #
+          # Returns an instance of the class that uses this mixin.
+          def from_json(json)
+            res = self.new
+
+            json.each do |k, v|
+              # TODO: Better way to do this?
+              attr = @attributes.find{|a| a.json_field == k.to_s}
+              raise InvalidAttribute.new(
+                "`#{self.name.split('::').last}` did not define a `#{k}`."
+              ) if attr.nil?
+
+              # TODO: Better way to do this?
+              case attr.type.to_s
+              when Integer.to_s
+                maybe_raise_invalid_value(attr, k, v) unless v.is_a?(Fixnum)
+                value = v.to_i
+              when Float.to_s
+                maybe_raise_invalid_value(attr, k, v) unless v.is_a?(Float)
+                value = v.to_f
+              when String.to_s
+                maybe_raise_invalid_value(attr, k, v) unless v.is_a?(String)
+                value = v
+              when Hash.to_s
+                maybe_raise_invalid_value(attr, k, v) unless v.is_a?(Hash)
+                value = v
+              end
+
+              res.send("#{attr.name}=", value)
             end
+
+            res
           end
 
-          def decode_result(json)
-            instance = self.new
-            self::JSON_MAP.each do |k,v|
-              instance.send("#{k}=", json[v])
+          private
+
+          def maybe_raise_invalid_value(attribute, key, value)
+            if value.nil?
+              return if attribute.allow_nil?
+
+              raise InvalidValue.new(
+                "`#{attribute.name}` is not allowed to be nil.",
+              )
             end
-            instance
+
+            raise InvalidValue.new(
+              "Expected #{attribute.type}, got #{value.class}. `#{key}` (#{value})."
+            )
           end
+
         end
       end
     end

data/lib/unchained/client/motd.rb

@@ -0,0 +1,19 @@
+module Unchained
+  class Client
+    module MOTD
+
+      class Message
+        include Unchained::Client::Mixins::Resource
+
+        attribute :id, String
+        attribute :message, String
+        attribute :duration, Integer
+      end
+
+      def motd(opts={})
+        get_resource("#{base_url}/messageoftheday", Message, opts)
+      end
+
+    end
+  end
+end

data/lib/unchained/client/patcher.rb

@@ -4,23 +4,21 @@ module Unchained
 
       class HeroContent
         include Unchained::Client::Mixins::Resource
-        resource({
-          :id => 'id',
-          :content => 'content',
-          :priority => 'priority',
-          :start => 'utcDateStart',
-          :end => 'utcDateEnd',
-        })
+
+        attribute :id, String
+        attribute :content, String
+        attribute :priority, Integer
+        attribute :start, String, json: 'utcDateStart'
+        attribute :end, String, json: 'utcDateEnd'
       end
 
       class Alert
         include Unchained::Client::Mixins::Resource
-        resource({
-          :id => 'id',
-          :message => 'message',
-          :start => 'utcDateStart',
-          :end => 'utcDateEnd',
-        })
+
+        attribute :id, String
+        attribute :message, String
+        attribute :start, String, json: 'utcDateStart'
+        attribute :end, String, json: 'utcDateEnd'
       end
 
       def patcher_hero_contents(opts={})

data/lib/unchained/client/races.rb

@@ -4,12 +4,11 @@ module Unchained
 
       class Race
         include Unchained::Client::Mixins::Resource
-        resource({
-          :description => 'description',
-          :faction => 'faction',
-          :id => 'id',
-          :name => 'name',
-        })
+
+        attribute :description, String
+        attribute :faction, Integer
+        attribute :id, Integer
+        attribute :name, String
       end
 
       def races(opts={})

data/lib/unchained/client/servers.rb

@@ -4,18 +4,19 @@ module Unchained
 
       class Server
         include Unchained::Client::Mixins::Resource
-        resource({
-          :access_level => 'accessLevel',
-          :channel_id => 'channelID',
-          :host => 'host',
-          :name => 'name',
-          :player_maximum => 'playerMaximum',
-          :shard_id => 'shardID',
-        })
+
+        attribute :access_level, Integer, json: 'accessLevel'
+        attribute :channel_id, Integer, json: 'channelID'
+        attribute :host, String
+        attribute :name, String
+        attribute :player_maximum, Integer, json: 'playerMaximum'
+        attribute :shard_id, Integer, json: 'shardID'
       end
 
-      def servers(opts={})
-        get_resources("#{base_url}/servers", Server, opts)
+      def servers(opts={}, channel: nil)
+        url = "#{base_url}/servers"
+        url += "/#{channel}" unless channel.nil?
+        get_resources(url, Server, opts)
       end
 
     end

data/lib/unchained/error.rb

@@ -3,5 +3,7 @@ module Unchained
   # TODO: Support more errors.
   class Error < StandardError; end
   class NotFound < Error; end
+  class InvalidValue < Error; end
+  class InvalidAttribute < Error; end
 
 end

data/lib/unchained/request.rb

@@ -16,9 +16,13 @@ module Unchained
       end
     end
 
+    def get_resource(url, resource_class, params={})
+      resource_class.from_json(get(url, params))
+    end
+
     def get_resources(url, resource_class, params={})
       get(url, params).map do |result|
-        resource_class.decode_result(result)
+        resource_class.from_json(result)
       end
     end