atdis 0.1 → 0.2

data/spec/atdis/model_spec.rb

@@ -24,16 +24,147 @@ describe ATDIS::Model do
     end
   end
 
+  describe ".map_field" do
+    let(:mappings) { { :foo => :bar, :a => :b, :info => { :foo => :bar2, :a => :b2, :c => :c2 } } }
+
+    context "one version of data" do
+      let(:data) { { :foo => 2, :a => 3, :d => 4, :info => { :foo => 2, :a => 3, :d => 4 } } }
+
+      it { ATDIS::Model.map_field(:bar, data, mappings).should == 2 }
+      it { ATDIS::Model.map_field(:b, data, mappings).should == 3 }
+      it { ATDIS::Model.map_field(:bar2, data, mappings).should == 2 }
+      it { ATDIS::Model.map_field(:b2, data, mappings).should == 3 }
+      it { ATDIS::Model.map_field(:c2, data, mappings).should be_nil }
+    end
+
+    context "another version of data" do
+      let(:data) { { :foo => 2, :a => 3, :d => 4 } }
+
+      it { ATDIS::Model.map_field(:bar, data, mappings).should == 2 }
+      it { ATDIS::Model.map_field(:b, data, mappings).should == 3 }
+      it { ATDIS::Model.map_field(:bar2, data, mappings).should be_nil }
+      it { ATDIS::Model.map_field(:b2, data, mappings).should be_nil }
+      it { ATDIS::Model.map_field(:c2, data, mappings).should be_nil }
+    end
+  end
+
+  describe ".unused_data" do
+    it do
+      ATDIS::Model.unused_data(
+      {
+        :foo => 2,
+        :a => 3,
+        :d => 4
+      },
+      {
+        :foo => :bar,
+        :a => :b
+      }).should ==
+      {
+        :d => 4
+      }
+    end
+
+    it do
+      ATDIS::Model.unused_data(
+      {
+        :foo => 2,
+        :a => 3,
+        :d => 4,
+        :info => {
+          :foo => 2,
+          :a => 3,
+          :d => 4
+        }
+      },
+      {
+        :foo => :bar,
+        :a => :b,
+        :info => {
+          :foo => :bar2,
+          :a => :b2
+        }
+      }).should ==
+      {
+        :d => 4,
+        :info => {
+          :d => 4
+        }
+      }
+    end
+  end
+
+  describe ".attribute_names_from_mappings" do
+    it do
+      # Doing this nastiness to support Ruby 1.8
+      h = ActiveSupport::OrderedHash.new
+      h[:foo] = :bar
+      h[:a] = :b
+      h2 = ActiveSupport::OrderedHash.new
+      h2[:foo] = :bar2
+      h2[:a] = :b2
+      h[:info] = h2
+      ATDIS::Model.attribute_names_from_mappings(h).should == [:bar, :b, :bar2, :b2]
+    end
+  end
+
   describe ".map_fields" do
     it do
-      ATDIS::Model.map_fields({:foo => :bar, :a => :b}, {:foo => 2, :a => 3, :d => 4}).should ==
-        {:bar => 2, :b => 3, :json_left_overs => {:d => 4}}
+      ATDIS::Model.map_fields(
+      {
+        :foo => 2,
+        :a => 3,
+        :d => 4
+      },
+      {
+        :foo => :bar,
+        :a => :b
+      }).should ==
+      {
+        :bar => 2,
+        :b => 3,
+      }
     end
 
     it do
-      ATDIS::Model.map_fields({:foo => :bar, :a => :b, :info => {:foo => :bar2, :a => :b2}},
-        {:foo => 2, :a => 3, :d => 4, :info => {:foo => 2, :a => 3, :d => 4}}).should ==
-        {:bar => 2, :b => 3, :bar2 => 2, :b2 => 3, :json_left_overs => {:d => 4, :info => {:d => 4}}}
+      ATDIS::Model.map_fields(
+      {
+        :foo => 2,
+        :a => 3,
+        :d => 4,
+        :info => {
+          :foo => 2,
+          :a => 3,
+          :d => 4
+        }
+      },
+      {
+        :foo => :bar,
+        :a => :b,
+        :info => {
+          :foo => :bar2,
+          :a => :b2
+        }
+      }).should ==
+      {
+        :bar => 2,
+        :b => 3,
+        :bar2 => 2,
+        :b2 => 3
+      }
+    end
+  end
+
+  describe "#json_attribute" do
+    let(:model) { ATDIS::Model.new }
+    let(:mapping) { {:previous => :previous_page_no, :next => :next_page_no, :foo => {:bar => :apple, :foo => :orange}} }
+
+    it "simple case" do
+      model.json_attribute(:previous_page_no, 12, mapping).should == {:previous => 12}
+    end
+
+    it "with recursion" do
+      model.json_attribute(:apple, 12, mapping).should == {:foo => {:bar => 12}}
     end
   end
 end

data/spec/atdis/page_spec.rb

@@ -1,6 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ATDIS::Page do
+  it ".attribute_names" do
+    ATDIS::Page.attribute_names.should == ["results", "count", "previous_page_no", "next_page_no", "current_page_no",
+      "no_results_per_page", "total_no_results", "total_no_pages"]
+  end
+
   describe "validations" do
     context "two valid applications no paging" do
       before :each do
@@ -27,7 +32,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:count => ["is not the same as the number of applications returned"]}
+            page.errors.messages.should == {:count => [ATDIS::ErrorMessage["is not the same as the number of applications returned", "6.5"]]}
           end
         end
 
@@ -38,7 +43,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:count => ["should not be larger than the number of results per page"]}
+            page.errors.messages.should == {:count => [ATDIS::ErrorMessage["should not be larger than the number of results per page", "6.5"]]}
           end
         end
 
@@ -49,7 +54,7 @@ describe ATDIS::Page do
 
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:count => ["should be present if pagination is being used"]}
+            page.errors.messages.should == {:count => [ATDIS::ErrorMessage["should be present if pagination is being used", "6.5"]]}
           end
         end
 
@@ -62,7 +67,8 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:previous_page_no => ["should be one less than current page number or null if first page"]}
+            page.errors.messages.should == {:previous_page_no => [ATDIS::ErrorMessage["should be one less than current page number or null if first page", "6.5"]]}
+            page.json_errors.should == [[{:pagination => {:previous => 5}}, [ATDIS::ErrorMessage["should be one less than current page number or null if first page", "6.5"]]]]
           end
         end
 
@@ -76,7 +82,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:previous_page_no => ["can't be null if not on the first page"]}
+            page.errors.messages.should == {:previous_page_no => [ATDIS::ErrorMessage["can't be null if not on the first page", "6.5"]]}
           end
         end
 
@@ -90,7 +96,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:previous_page_no => ["should be null if on the first page"]}
+            page.errors.messages.should == {:previous_page_no => [ATDIS::ErrorMessage["should be null if on the first page", "6.5"]]}
           end
         end
 
@@ -102,7 +108,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:next_page_no => ["should be one greater than current page number or null if last page"]}
+            page.errors.messages.should == {:next_page_no => [ATDIS::ErrorMessage["should be one greater than current page number or null if last page", "6.5"]]}
           end          
         end
 
@@ -116,7 +122,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:next_page_no => ["can't be null if not on the last page"]}
+            page.errors.messages.should == {:next_page_no => [ATDIS::ErrorMessage["can't be null if not on the last page", "6.5"]]}
           end
         end
 
@@ -130,7 +136,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:next_page_no => ["should be null if on the last page"]}
+            page.errors.messages.should == {:next_page_no => [ATDIS::ErrorMessage["should be null if on the last page", "6.5"]]}
           end
         end
 
@@ -143,7 +149,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:current_page_no => ["is larger than the number of pages"]}
+            page.errors.messages.should == {:current_page_no => [ATDIS::ErrorMessage["is larger than the number of pages", "6.5"]]}
           end
         end
 
@@ -154,7 +160,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:current_page_no => ["can not be less than 1"]}
+            page.errors.messages.should == {:current_page_no => [ATDIS::ErrorMessage["can not be less than 1", "6.5"]]}
           end          
         end
 
@@ -168,7 +174,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:total_no_results => ["is larger than can be retrieved through paging"]}
+            page.errors.messages.should == {:total_no_results => [ATDIS::ErrorMessage["is larger than can be retrieved through paging", "6.5"]]}
           end          
         end
 
@@ -182,7 +188,7 @@ describe ATDIS::Page do
           end
           it do
             page.should_not be_valid
-            page.errors.messages.should == {:total_no_results => ["could fit into a smaller number of pages"]}
+            page.errors.messages.should == {:total_no_results => [ATDIS::ErrorMessage["could fit into a smaller number of pages", "6.5"]]}
           end          
         end
       end
@@ -197,25 +203,121 @@ describe ATDIS::Page do
 
       it do
         page.should_not be_valid
-        page.errors.messages.should == {:results => ["is not valid"]}
+        page.errors.messages.should == {:results => [ATDIS::ErrorMessage["is not valid", nil]]}
       end
     end
 
     context "two invalid applications no paging" do
+      let(:a1) { double(:valid? => false, :json_errors => [[{:dat_id => "null"}, ["can not be empty"]]]) }
+      let(:a2) { double(:valid? => false) }
       before :each do
-        ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(double(:valid? => false))
-        ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(double(:valid? => false))
+        ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(a1)
+        ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(a2)
       end
       let(:page) { ATDIS::Page.new(:results => [{:description => "application1"}, {:description => "application2"}]) }
 
       it do
         page.should_not be_valid
-        page.errors.messages.should == {:results => ["is not valid"]}
+        page.errors.messages.should == {:results => [ATDIS::ErrorMessage["is not valid", nil]]}
+      end
+
+      it "the errors from the first errored application should be here" do
+        page.should_not be_valid
+        page.json_errors.should == [[{:response => {:dat_id => "null"}} , ["can not be empty"]]]
+      end
+
+    end
+  end
+
+  describe ".level_used?" do
+    describe "level 1" do
+      context "two applications" do
+        before :each do
+          ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(double)
+          ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(double)
+        end
+        let(:page) { ATDIS::Page.new(:results => [{:description => "application1"}, {:description => "application2"}]) }
+
+        it { page.level_used?(1).should be_true }
+      end
+
+      context "no L1 features used" do
+        let(:page) { ATDIS::Page.new }
+        it { page.level_used?(1).should be_false }
+      end
+    end
+
+    describe "level 2" do
+      context "two applications with only L1 features" do
+        let(:a1) { double }
+        let(:a2) { double }
+        before :each do
+          ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(a1)
+          ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(a2)
+        end
+        let(:page) { ATDIS::Page.new(:results => [{:description => "application1"}, {:description => "application2"}]) }
+
+        it do
+          a1.should_receive(:level_used?).with(2).and_return(false)
+          a2.should_receive(:level_used?).with(2).and_return(false)
+          page.level_used?(2).should be_false
+        end
+
+        context "L2 feature used on Page" do
+          before :each do
+            page.count = 2
+          end
+
+          it { page.level_used?(2).should be_true }
+        end
+      end
+
+      context "two applications with L2 features" do
+        let(:a1) { double }
+        let(:a2) { double }
+        before :each do
+          ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(a1)
+          ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(a2)
+        end
+        let(:page) { ATDIS::Page.new(:results => [{:description => "application1"}, {:description => "application2"}]) }
+
+        it "should ask the applications whether they have L2 features" do
+          a1.should_receive(:level_used?).with(2).and_return(true)
+          page.level_used?(2).should be_true
+        end
       end
     end
   end
 
   context "paging supported by vendor" do
+    context "read a from an invalid json string" do
+      let(:page) { ATDIS::Page.read_json(<<-EOF
+{
+  "response": [
+    {
+      "application": {
+        "description": "application2"
+      }      
+    }
+  ],
+}        
+       EOF
+        )}
+
+      it do
+        page.should_not be_valid
+        page.errors.messages.has_key?(:json).should be_true
+        page.errors.messages.count.should == 1
+        # The error messages returned by the library are different for different Ruby versions
+        ruby18_message = ATDIS::ErrorMessage['Invalid JSON: unexpected "}"', nil]
+        ruby19_message = ATDIS::ErrorMessage["Invalid JSON: 784: unexpected token at '{\n  \"response\": [\n    {\n      \"application\": {\n        \"description\": \"application2\"\n      }      \n    }\n  ],\n}        \n'", nil]
+        ruby20_message = ATDIS::ErrorMessage["Invalid JSON: 795: unexpected token at '{\n  \"response\": [\n    {\n      \"application\": {\n        \"description\": \"application2\"\n      }      \n    }\n  ],\n}        \n'", nil]
+        page.errors.messages[:json].count.should == 1
+        message = page.errors.messages[:json].first
+        (message == ruby18_message || message == ruby19_message || message == ruby20_message).should be_true
+      end
+    end
+
     context "read from a json string" do
       let(:page) { ATDIS::Page.read_json(<<-EOF
 {

data/spec/atdis/person_spec.rb

@@ -1,6 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ATDIS::Person do
+  it ".attribute_names" do
+    ATDIS::Person.attribute_names.should == ["name", "role", "contact"]
+  end
+
   it ".name" do
     ATDIS::Person.interpret(:name => "Tuttle").name.should == "Tuttle"
   end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: atdis
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Matthew Landauer
@@ -14,12 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-09-11 00:00:00 Z
+date: 2013-09-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -29,12 +28,12 @@ dependencies:
         - 1
         - 3
         version: "1.3"
+  prerelease: false
   type: :development
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,12 +42,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :development
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: multi_json
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -58,12 +57,12 @@ dependencies:
         - 1
         - 7
         version: "1.7"
+  prerelease: false
   type: :runtime
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: rest-client
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,12 +71,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :runtime
-  version_requirements: *id004
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: rgeo-geojson
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -86,12 +85,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :runtime
-  version_requirements: *id005
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   name: activemodel
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -100,8 +99,9 @@ dependencies:
         segments: 
         - 3
         version: "3"
+  prerelease: false
   type: :runtime
-  version_requirements: *id006
+  requirement: *id006
 description: A ruby interface to the application tracking data interchange specification (ATDIS) API
 email: 
 - matthew@openaustraliafoundation.org.au
@@ -121,8 +121,8 @@ files:
 - README.md
 - Rakefile
 - atdis.gemspec
-- docs/ATDIS-1.0.4 Application Tracking Data Interchange Specification.docx
-- docs/ATDIS-1.0.4 Application Tracking Data Interchange Specification.pdf
+- docs/ATDIS-1.0.7 Application Tracking Data Interchange Specification (v1.0).doc
+- docs/ATDIS-1.0.7 Application Tracking Data Interchange Specification (v1.0).pdf
 - lib/atdis.rb
 - lib/atdis/application.rb
 - lib/atdis/document.rb