atdis 0.1

data/spec/atdis/page_spec.rb

@@ -0,0 +1,390 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ATDIS::Page do
+  describe "validations" do
+    context "two valid applications no paging" do
+      before :each do
+        ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(double(:valid? => true))
+        ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(double(:valid? => true))
+      end
+      let(:page) { ATDIS::Page.new(:results => [{:description => "application1"}, {:description => "application2"}]) }
+
+      it {page.should be_valid}
+
+      context "with pagination" do
+        before :each do
+          page.count = 2
+          page.no_results_per_page = 25
+          page.current_page_no = 1
+          page.total_no_results = 2
+          page.total_no_pages = 1
+        end
+        it { page.should be_valid }
+
+        context "count is not consistent" do
+          before :each do
+            page.count = 1
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:count => ["is not the same as the number of applications returned"]}
+          end
+        end
+
+        context "count is larger than number of results per page" do
+          before :each do
+            page.no_results_per_page = 1
+            page.total_no_results = 1
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:count => ["should not be larger than the number of results per page"]}
+          end
+        end
+
+        context "count is absent" do
+          before :each do
+            page.count = nil
+          end
+
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:count => ["should be present if pagination is being used"]}
+          end
+        end
+
+        context "previous page number is pointing to a weird page number" do
+          before :each do
+            page.previous_page_no = 5
+            page.current_page_no = 2
+            page.total_no_results = 50
+            page.total_no_pages = 2
+          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"]}
+          end
+        end
+
+        context "previous page number if nil but not on first page" do
+          before :each do
+            page.current_page_no = 4
+            page.next_page_no = 5
+            page.previous_page_no = nil
+            page.total_no_results = 240
+            page.total_no_pages = 10
+          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"]}
+          end
+        end
+
+        context "previous page number not nil but on first page" do
+          before :each do
+            page.current_page_no = 1
+            page.next_page_no = 2
+            page.previous_page_no = 0
+            page.total_no_results = 240
+            page.total_no_pages = 10
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:previous_page_no => ["should be null if on the first page"]}
+          end
+        end
+
+        context "next page number is pointing to a weird page number" do
+          before :each do
+            page.next_page_no = 5
+            page.total_no_results = 50
+            page.total_no_pages = 2
+          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"]}
+          end          
+        end
+
+        context "next page number is nil but not on last page" do
+          before :each do
+            page.current_page_no = 4
+            page.previous_page_no = 3
+            page.next_page_no = nil
+            page.total_no_results = 140
+            page.total_no_pages = 6
+          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"]}
+          end
+        end
+
+        context "next page number is not nil but on last page" do
+          before :each do
+            page.previous_page_no = 3
+            page.current_page_no = 4
+            page.next_page_no = 5
+            page.total_no_results = 100
+            page.total_no_pages = 4
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:next_page_no => ["should be null if on the last page"]}
+          end
+        end
+
+        context "current page is larger than the number of pages" do
+          before :each do
+            page.current_page_no = 2
+            page.previous_page_no = 1
+            page.next_page_no = 3
+            page.total_no_pages = 1
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:current_page_no => ["is larger than the number of pages"]}
+          end
+        end
+
+        context "current page is zero" do
+          before :each do
+            page.current_page_no = 0
+            page.next_page_no = 1
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:current_page_no => ["can not be less than 1"]}
+          end          
+        end
+
+        context "total_no_results is larger than would be expected" do
+          before :each do
+            page.current_page_no = 1
+            page.next_page_no = 2
+            page.no_results_per_page = 25
+            page.total_no_pages = 4
+            page.total_no_results = 101
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:total_no_results => ["is larger than can be retrieved through paging"]}
+          end          
+        end
+
+        context "total no_results is less than would be expected" do
+          before :each do
+            page.current_page_no = 1
+            page.next_page_no = 2
+            page.no_results_per_page = 25
+            page.total_no_pages = 4
+            page.total_no_results = 75
+          end
+          it do
+            page.should_not be_valid
+            page.errors.messages.should == {:total_no_results => ["could fit into a smaller number of pages"]}
+          end          
+        end
+      end
+    end
+
+    context "one valid application out of two no paging" do
+      before :each do
+        ATDIS::Application.should_receive(:interpret).with(:description => "application1").and_return(double(:valid? => true))
+        ATDIS::Application.should_receive(:interpret).with(:description => "application2").and_return(double(:valid? => false))
+      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"]}
+      end
+    end
+
+    context "two invalid applications no paging" do
+      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))
+      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"]}
+      end
+    end
+  end
+
+  context "paging supported by vendor" do
+    context "read from a json string" do
+      let(:page) { ATDIS::Page.read_json(<<-EOF
+{
+  "response": [
+    {
+      "application": {
+        "description": "application1"
+      }     
+    },
+    {
+      "application": {
+        "description": "application2"
+      }      
+    }
+  ],
+  "count": 2,
+  "pagination": {
+    "previous": 1,
+    "next": 3,
+    "current": 2,
+    "per_page": 2,
+    "count": 50,
+    "pages": 25
+  }
+}        
+       EOF
+        )}
+      it ".results" do
+        application1 = double("Application")
+        application2 = double("Application")
+        ATDIS::Application.should_receive(:interpret).with(:application => {:description => "application1"}).and_return(application1)
+        ATDIS::Application.should_receive(:interpret).with(:application => {:description => "application2"}).and_return(application2)
+
+        page.results.should == [application1, application2]
+      end
+
+      it ".next" do
+        expect { page.next }.to raise_error "Can't use next_url when loaded with read_json"
+      end
+    end
+
+    context "read from a url" do
+      before :each do
+        # Mock network response
+        RestClient.should_receive(:get).with("http://www.council.nsw.gov.au/atdis/1.0/applications.json").and_return(double(:to_str => <<-EOF
+  {
+    "response": [
+      {
+        "application": {
+          "description": "application1"
+        }     
+      },
+      {
+        "application": {
+          "description": "application2"
+        }      
+      }
+    ]
+  }
+        EOF
+        ))
+      end
+
+      let(:applications_results) { ATDIS::Page.read_url("http://www.council.nsw.gov.au/atdis/1.0/applications.json") }
+
+      it ".results" do
+        application1 = double("Application")
+        application2 = double("Application")
+        ATDIS::Application.should_receive(:interpret).with(:application => {:description => "application1"}).and_return(application1)
+        ATDIS::Application.should_receive(:interpret).with(:application => {:description => "application2"}).and_return(application2)
+
+        applications_results.results.should == [application1, application2]
+      end
+
+      it ".next" do
+        applications_results.next.should be_nil
+      end
+
+      it ".previous_page_no" do
+        applications_results.previous_page_no.should be_nil
+      end
+
+      it ".next_page_no" do
+        applications_results.next_page_no.should be_nil
+      end
+
+      it ".current_page_no" do
+        applications_results.current_page_no.should be_nil
+      end
+
+      it ".no_results_per_page" do
+        applications_results.no_results_per_page.should be_nil
+      end
+
+      it ".total_no_results" do
+        applications_results.total_no_results.should be_nil
+      end
+
+      it ".total_no_pages" do
+        applications_results.total_no_pages.should be_nil
+      end
+      end
+  end
+
+  context "paging supported by vendor" do
+    before :each do
+      RestClient.should_receive(:get).with("http://www.council.nsw.gov.au/atdis/1.0/applications.json?page=2").and_return(double(:to_str => <<-EOF
+{
+  "response": [
+    {
+      "application": {
+        "description": "application1"
+      }     
+    },
+    {
+      "application": {
+        "description": "application2"
+      }      
+    }
+  ],
+  "count": 2,
+  "pagination": {
+    "previous": 1,
+    "next": 3,
+    "current": 2,
+    "per_page": 2,
+    "count": 50,
+    "pages": 25
+  }
+}        
+      EOF
+      ))
+    end
+
+    let(:applications_results) { ATDIS::Page.read_url("http://www.council.nsw.gov.au/atdis/1.0/applications.json?page=2") }
+
+    it ".previous_page_no" do
+      applications_results.previous_page_no.should == 1
+    end
+
+    it ".next_page_no" do
+      applications_results.next_page_no.should == 3
+    end
+
+    it ".current_page_no" do
+      applications_results.current_page_no.should == 2
+    end
+
+    it ".no_results_per_page" do
+      applications_results.no_results_per_page.should == 2
+    end
+
+    it ".total_no_results" do
+      applications_results.total_no_results.should == 50
+    end
+
+    it ".total_no_pages" do
+      applications_results.total_no_pages.should == 25
+    end
+
+    it ".next_url" do
+      applications_results.next_url.should == "http://www.council.nsw.gov.au/atdis/1.0/applications.json?page=3"
+    end
+
+    it ".next" do
+      n = double("Page")
+      applications_results
+      ATDIS::Page.should_receive(:read_url).with("http://www.council.nsw.gov.au/atdis/1.0/applications.json?page=3").and_return(n)
+      applications_results.next.should == n
+    end
+  end
+end

data/spec/atdis/person_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ATDIS::Person do
+  it ".name" do
+    ATDIS::Person.interpret(:name => "Tuttle").name.should == "Tuttle"
+  end
+
+  it ".role" do
+    ATDIS::Person.interpret(:role => "Heating Engineer").role.should == "Heating Engineer"
+  end
+
+  it ".contact" do
+    ATDIS::Person.interpret(:contact => "94-FLUSH").contact.should == "94-FLUSH"
+  end
+end

data/spec/atdis/separated_url_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ATDIS::SeparatedURL do
+  describe "#merge" do
+    it "should add a new parameter" do
+      ATDIS::SeparatedURL.merge("http://foo.com/bar?foo=twenty&bar=12", :page => 2).should ==
+        "http://foo.com/bar?bar=12&foo=twenty&page=2"
+    end
+
+    it "should overwrite an existing one" do
+      ATDIS::SeparatedURL.merge("http://foo.com/bar?foo=twenty&bar=12", :bar => 24).should ==
+        "http://foo.com/bar?bar=24&foo=twenty"
+    end
+
+    it "should encode spaces for example" do
+      ATDIS::SeparatedURL.merge("http://foo.com/bar?foo=twenty&bar=12", :bar => "hello sir").should ==
+        "http://foo.com/bar?bar=hello+sir&foo=twenty"
+    end
+
+    it "should be fine if there are no parameters" do
+      ATDIS::SeparatedURL.merge("http://foo.com/bar", :page => 2).should ==
+        "http://foo.com/bar?page=2"
+    end
+
+    it "should be fine if there are no parameters" do
+      ATDIS::SeparatedURL.merge("http://foo.com/bar", {}).should ==
+        "http://foo.com/bar"
+    end
+
+    it "should be able to handle port numbers in URLS" do
+      ATDIS::SeparatedURL.merge("http://foo.com:3000/bar", {}).should ==
+        "http://foo.com:3000/bar"      
+    end
+
+    it "should be able to handle https" do
+      ATDIS::SeparatedURL.merge("https://foo.com/bar", {}).should ==
+        "https://foo.com/bar"
+    end
+   end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'coveralls'
+
+# Generate coverage locally in html as well as in coveralls.io
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'atdis' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: atdis
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Matthew Landauer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rgeo-geojson
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id006
+description: A ruby interface to the application tracking data interchange specification (ATDIS) API
+email: 
+- matthew@openaustraliafoundation.org.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- 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
+- lib/atdis.rb
+- lib/atdis/application.rb
+- lib/atdis/document.rb
+- lib/atdis/event.rb
+- lib/atdis/feed.rb
+- lib/atdis/location.rb
+- lib/atdis/model.rb
+- lib/atdis/page.rb
+- lib/atdis/person.rb
+- lib/atdis/separated_url.rb
+- lib/atdis/validators.rb
+- lib/atdis/version.rb
+- spec/atdis/application_spec.rb
+- spec/atdis/document_spec.rb
+- spec/atdis/event_spec.rb
+- spec/atdis/feed_spec.rb
+- spec/atdis/location_spec.rb
+- spec/atdis/model_spec.rb
+- spec/atdis/page_spec.rb
+- spec/atdis/person_spec.rb
+- spec/atdis/separated_url_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/openaustralia/atdis
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A ruby interface to the application tracking data interchange specification (ATDIS) API
+test_files: 
+- spec/atdis/application_spec.rb
+- spec/atdis/document_spec.rb
+- spec/atdis/event_spec.rb
+- spec/atdis/feed_spec.rb
+- spec/atdis/location_spec.rb
+- spec/atdis/model_spec.rb
+- spec/atdis/page_spec.rb
+- spec/atdis/person_spec.rb
+- spec/atdis/separated_url_spec.rb
+- spec/spec_helper.rb