unchained 0.0.2 → 0.0.3

data/test/_fixtures/vcr_cassettes/faction.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Sun, 24 Apr 2016 02:02:11 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Sun, 24 Apr 2016 02:02:15 GMT
+recorded_with: VCR 3.0.1

data/test/_fixtures/vcr_cassettes/races.yml

@@ -27,12 +27,264 @@ http_interactions:
       Server:
       - Microsoft-HTTPAPI/2.0
       Date:
-      - Fri, 22 Apr 2016 15:47:10 GMT
+      - Fri, 22 Apr 2016 23:09:31 GMT
     body:
       encoding: UTF-8
       string: '[{"name":"Luchorpan","description":"Luchorpan","faction":1,"id":2},{"name":"Valkyrie","description":"Valkyrie","faction":2,"id":4},{"name":"Human","description":"Viking
         Human","faction":2,"id":15},{"name":"Human","description":"Arthurian Human","faction":3,"id":16},{"name":"Human","description":"TDD
         Human","faction":1,"id":17},{"name":"Pict","description":"Pictish?","faction":3,"id":18}]'
     http_version: 
-  recorded_at: Fri, 22 Apr 2016 15:47:31 GMT
+  recorded_at: Fri, 22 Apr 2016 23:09:53 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:53 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:53 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:54 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:54 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:54 GMT
+- request:
+    method: get
+    uri: http://api.camelotunchained.com/v1/gamedata/factions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Logintoken:
+      - ''
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '362'
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - Microsoft-HTTPAPI/2.0
+      Date:
+      - Fri, 22 Apr 2016 23:09:32 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3siZGVzY3JpcHRpb24iOiJObyBGYWN0aW9uIG9yIEFsbCBGYWN0aW9ucyAo
+        TlBDIE9ubHkpIiwiaWQiOjAsIm5hbWUiOiJGYWN0aW9ubGVzcyIsInNob3J0
+        TmFtZSI6IkZhY3Rpb25sZXNzIn0seyJkZXNjcmlwdGlvbiI6IlRoZSBUdWF0
+        aGEgRMOpIERhbmFubiIsImlkIjoxLCJuYW1lIjoiVHVhdGhhIETDqSBEYW5h
+        bm4iLCJzaG9ydE5hbWUiOiJUREQifSx7ImRlc2NyaXB0aW9uIjoiVGhlIFZp
+        a2luZ3MiLCJpZCI6MiwibmFtZSI6IlZpa2luZ3MiLCJzaG9ydE5hbWUiOiJW
+        aWtpbmcifSx7ImRlc2NyaXB0aW9uIjoiVGhlIEFydGh1cmlhbnMiLCJpZCI6
+        MywibmFtZSI6IkFydGh1cmlhbnMiLCJzaG9ydE5hbWUiOiJBcnRodXJpYW4i
+        fV0=
+    http_version: 
+  recorded_at: Fri, 22 Apr 2016 23:09:54 GMT
 recorded_with: VCR 3.0.1

data/test/unchained/client/archetypes_test.rb

@@ -13,10 +13,44 @@ describe Unchained::Client::Archetypes do
         assert_equal(9, archetypes.count, "Expected 9 archetypes")
 
         archetype = archetypes.first
+
+        assert(
+          archetype.is_a?(Unchained::Client::Archetypes::Archetype),
+          'Expected `archetypes` to return Archetypes.',
+        )
+
         assert_equal('The Dark Knight', archetype.description)
-        assert_equal(3, archetype.faction)
         assert_equal(7, archetype.id)
         assert_equal('Black Knight', archetype.name)
+
+        # check that it expands the faction
+        assert(
+          archetype.faction.is_a?(Unchained::Client::Factions::Faction),
+          'Expected `faction` to be expanded.',
+        )
+      end
+    end
+  end
+
+  describe '.archetype' do
+    it 'should fetch from the API' do
+      VCR.use_cassette('archetypes') do
+        archetype = @client.archetype(7)
+
+        assert(
+          archetype.is_a?(Unchained::Client::Archetypes::Archetype),
+          'Expected `archetype` to return an Archetype.',
+        )
+
+        assert_equal('The Dark Knight', archetype.description)
+        assert_equal(7, archetype.id)
+        assert_equal('Black Knight', archetype.name)
+
+        # check that it expands the faction
+        assert(
+          archetype.faction.is_a?(Unchained::Client::Factions::Faction),
+          'Expected `faction` to be expanded.',
+        )
       end
     end
   end

data/test/unchained/client/attributes_test.rb

@@ -11,6 +11,20 @@ describe Unchained::Client::Attributes do
       VCR.use_cassette('attributes') do
         attributes = @client.attributes(1)
         assert_equal(37, attributes.count)
+
+        attribute = attributes.first
+        assert(
+          attribute.is_a?(Unchained::Client::Attributes::AttributeInfo),
+          'Expected `attributes(i)` to return AttributeInfos.',
+        )
+
+        assert_equal(30.0, attribute.base_value)
+        assert_equal('None', attribute.derived_from)
+        assert_match(/power of the character's magic effects/, attribute.description)
+        assert_equal(100.0, attribute.max_or_multiplier)
+        assert_equal('Attunement', attribute.name)
+        assert_equal(1, attribute.type)
+        assert_equal('units', attribute.units)
       end
     end
   end
@@ -20,6 +34,28 @@ describe Unchained::Client::Attributes do
       VCR.use_cassette('attribute_offsets') do
         offsets = @client.attribute_offsets(1)
         assert_equal(12, offsets.count)
+
+        offset = offsets.first
+        assert(
+          offset.is_a?(Unchained::Client::Attributes::AttributeOffset),
+          'Expected `attribute_offsets` to return AttributeOffsets.',
+        )
+
+        assert(
+          offset.race.is_a?(Unchained::Client::Races::Race),
+          'Expected `race` to be a Race.',
+        )
+
+        assert_equal(1, offset.gender)
+
+        # Assert a few of the hash elements.
+        assert(
+          offset.offsets.is_a?(Hash),
+          'Expected `offsets` to be a Hash.',
+        )
+        assert_equal(1.0, offset.offsets['Strength'])
+        assert_equal(-4.0, offset.offsets['Attunement'])
+        assert_equal(5.0, offset.offsets['Presence'])
       end
     end
   end

data/test/unchained/client/factions_test.rb

@@ -11,6 +11,34 @@ describe Unchained::Client::Factions do
       VCR.use_cassette('factions') do
         factions = @client.factions
         assert_equal(4, factions.count)
+
+        faction = factions.first
+        assert(
+          faction.is_a?(Unchained::Client::Factions::Faction),
+          'Expected `factions` to return Factions.',
+        )
+
+        assert_equal(0, faction.id)
+        assert_match(/NPC Only/, faction.description)
+        assert_equal('Factionless', faction.name)
+        assert_equal('Factionless', faction.short_name)
+      end
+    end
+  end
+
+  describe '.faction' do
+    it 'should fetch from the API' do
+      VCR.use_cassette('faction') do
+        faction = @client.faction(1)
+        assert(
+          faction.is_a?(Unchained::Client::Factions::Faction),
+          'Expected `factions` to return Factions.',
+        )
+
+        assert_equal(1, faction.id)
+        assert_equal('The Tuatha Dé Danann', faction.description)
+        assert_equal('Tuatha Dé Danann', faction.name)
+        assert_equal('TDD', faction.short_name)
       end
     end
   end

data/test/unchained/client/mixins/resource_test.rb

@@ -7,32 +7,112 @@ describe 'Resource Mixin' do
 
     attribute :company, String, allow_nil: true
     attribute :name, String, allow_nil: false
-    attribute :city, String
+    attribute :city, String, json: 'someField'
+    attribute :expanded, String, expand: :foo
+  end
+
+  describe 'attributes' do
+    it 'should set up instance methods for each attribute' do
+      resource = SampleResource.new
+      resource.company = 'CSE'
+      assert_equal('CSE', resource.company)
+    end
+
+    it 'should let you get a list of attributes from the class' do
+      attributes = SampleResource.attributes
+      assert_equal(4, attributes.count)
+
+      attribute = attributes.find{|a| a.name == :company}
+      assert(attribute, 'Expected an attribute with a name of `:company`.')
+
+      assert_equal(:company, attribute.name)
+      assert_equal(String, attribute.type)
+      assert_equal({allow_nil: true}, attribute.opts)
+    end
+
+    it 'should not let you set the attributes on the class' do
+      refute(
+        SampleResource.respond_to?("attributes="),
+        'The Resource should not setup `attributes=`.',
+      )
+    end
   end
 
   describe 'nil attributes' do
     it 'should allow nil values' do
-      resource = SampleResource.from_json(company: nil)
+      resource = SampleResource.from_hash(company: nil)
       assert_nil(resource.company, 'Expected `company` to be nil')
     end
 
     it 'should parse non-nil values correctly' do
-      resource = SampleResource.from_json(company: 'CSE')
+      resource = SampleResource.from_hash(company: 'CSE')
       assert_equal('CSE', resource.company, 'Expected `company` to be set.')
     end
 
     it 'should allow you to disable nil explicitly' do
       assert_raises(Unchained::InvalidValue) do
-        SampleResource.from_json(name: nil)
+        SampleResource.from_hash(name: nil)
       end
     end
 
     it 'should default to not allow nil' do
       assert_raises(Unchained::InvalidValue) do
-        SampleResource.from_json(city: nil)
+        SampleResource.from_hash(someField: nil)
       end
     end
   end
 
+  describe 'helper methods' do
+    before do
+      @resource = SampleResource.new
+    end
+
+    def find_attribute(name)
+      SampleResource.attributes.find{|a| a.name == name}
+    end
+
+    describe '#json_field' do
+      it 'should default to the name' do
+        attribute = find_attribute(:company)
+        assert_equal('company', attribute.json_field)
+      end
+
+      it 'should allow you to override' do
+        attribute = find_attribute(:city)
+        assert_equal('someField', attribute.json_field)
+      end
+    end
+
+    describe '#allow_nil?' do
+      it 'should default to false' do
+        attribute = find_attribute(:city)
+        refute(
+          attribute.allow_nil?,
+          'Expected `allow_nil?` to default to false.',
+        )
+      end
+
+      it 'should allow you to override' do
+        attribute = find_attribute(:company)
+        assert(
+          attribute.allow_nil?,
+          'Expected `allow_nil?` to be set to true.',
+        )
+      end
+    end
+
+    describe '#expand_method' do
+      it 'should default to nil' do
+        attribute = find_attribute(:name)
+        assert_nil(attribute.expand_method)
+      end
+
+      it 'should allow you to override' do
+        attribute = find_attribute(:expanded)
+        assert_equal(:foo, attribute.expand_method)
+      end
+    end
+
+  end
 end