ppe_api 0.0.1

data/lib/ppe_api/abstract_pa.rb

@@ -0,0 +1,5 @@
+module PPE_API
+  class AbstractPa 
+    
+  end
+end

data/lib/ppe_api/alternative_name.rb

@@ -0,0 +1,5 @@
+module PPE_API
+  class AlternativeName 
+    
+  end
+end

data/lib/ppe_api/apa_relation.rb

@@ -0,0 +1,5 @@
+module PPE_API
+  class ApaRelation 
+    
+  end
+end

data/lib/ppe_api/country.rb

@@ -0,0 +1,29 @@
+module PPE_API
+  class Country  
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :iso, String
+    element :iso_3, String, :tag=>'iso-3'
+    element :the_geom, String, :tag=>'the-geom'
+    element :numareas, Integer
+    element :name, String
+    has_one :region, Region
+    
+    def geometry_json
+      JSON.parse(@the_geom)
+    end
+    
+    def self.get_by_iso(iso)
+      res, data = ::DR::Config.http.get("/api/country/iso/#{iso}")
+      Country.parse(data) unless data.nil? || data.empty?
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "country"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/dataset.rb

@@ -0,0 +1,23 @@
+module PPE_API
+  class Dataset 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :author, String
+    element :year, Integer
+    element :citation, String
+    has_one :user, User
+    
+    def ==(data)
+      return false if data.nil?
+      data.author==self.author && data.year = self.year && data.citation==self.citation && self.user.id == data.user.id
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "dataset"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/designation.rb

@@ -0,0 +1,28 @@
+module PPE_API
+  class Designation 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :name, String
+    element :updated_at, DateTime, :tag=>'updated-at'
+    has_one :jurisdiction, Jurisdiction
+    
+    def self.get_by_name(name)
+      res, data = ::DR::Config.http.post("/api/designation/name", "name=#{name}")
+      return Designation.parse(data) unless data.nil? || data.empty?
+      return nil
+      
+    end
+    
+    def ==(des)
+      return false if des.nil?
+      des.name==self.name
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "designation"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/iucn_category.rb

@@ -0,0 +1,29 @@
+module PPE_API
+  class IucnCategory 
+    include ::HappyMapper
+    
+    tag 'iucn-category'
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :name, String 
+    element :value, Integer
+    
+    def self.get_by_name(name)
+      res, data = ::DR::Config.http.get("/api/iucn_category/name/#{name}")
+      return IucnCategory.parse(data) unless data.nil? || data.empty?
+      return nil
+      
+    end
+    
+    def ==(iucn)
+      return false if iucn.nil?
+      iucn.name==self.name
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "iucn-category"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/jurisdiction.rb

@@ -0,0 +1,15 @@
+module PPE_API
+  class Jurisdiction 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :name, String
+    element :updated_at, DateTime, :tag=>'updated-at'
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "jurisdiction"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/language.rb

@@ -0,0 +1,15 @@
+module PPE_API
+  class Language
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :name, String
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "language"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/legal_status.rb

@@ -0,0 +1,29 @@
+module PPE_API
+  class LegalStatus 
+    include ::HappyMapper
+    
+    tag 'legal-status'
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :name, String
+    
+    def self.get_by_name(name)
+      unless name.nil? || name.empty?
+        res, data = ::DR::Config.http.post("/api/legal_status/name", "name=#{name}")
+        return LegalStatus.parse(data) unless data.nil? || data.empty?
+      end
+      return nil
+    end
+    
+    def ==(legal_status)
+      return false if legal_status.nil?
+      legal_status.name==self.name
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "legal-status"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/point_geom.rb

@@ -0,0 +1,15 @@
+module PPE_API
+  class PointGeom 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :the_geom, String
+    
+    def geometry_json
+      JSON.parse(@the_geom)
+    end
+    
+  end
+end

data/lib/ppe_api/polygon_geom.rb

@@ -0,0 +1,15 @@
+module PPE_API
+  class PolygonGeom 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :the_geom, String
+    
+    def geometry_json
+      JSON.parse(@the_geom)
+    end
+    
+  end
+end

data/lib/ppe_api/protected_area.rb

@@ -0,0 +1,108 @@
+module PPE_API
+  class ProtectedArea 
+    include ::HappyMapper
+    
+    @@simple_atts = ["english_name", "id", "local_name", "state", "status_date", "total_area", "total_area_marine", "valid_from", "legally_reclassified", "legally_reduced", "legally_extended"] 
+    @@xml_atts = ["english_name", "id", "local_name", "status_date", "total_area", "total_area_marine", "legally_reclassified", "legally_reduced", "legally_extended", "geometry_as_hex_ewkb", "countries", "dataset", "iucn_category", "designation"]
+    
+    tag 'protected-area'
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :state, String
+    element :english_name, String, :tag=>"english-name"
+    element :local_name, String, :tag=>"local-name"
+    element :total_area, Float, :tag=>"total-area"
+    element :total_area_marine, Float, :tag=>"total-area-marine"
+    element :status_date, DateTime, :tag=>"status-date"
+    element :valid_from, DateTime, :tag=>"valid-from"
+    has_one :iucn_category, IucnCategory, :tag=>"iucn-category"
+    has_one :legal_status, LegalStatus, :tag=>"legal-status"
+    has_one :designation, Designation
+    element :legally_extended, Boolean, :tag=>"legally-extended"
+    element :legally_reduced, Boolean, :tag=>"legally-reduced"
+    element :legally_reclassified, Boolean, :tag=>"legally-reclassified"
+    element :geometry_as_hex_ewkb, String, :tag=>"geometry-as-hex-ewkb"
+    has_many :countries, Country
+    has_one :user, User
+    has_one :dataset, Dataset
+    has_one :site, Site
+    
+    def countries_iso
+      countries.collect{|a| a.iso+", "}.to_s.chop.chop
+    end
+    
+    def geometry
+      puts "in protected area looking at what i am #{self.inspect}"
+      @geometry = GeoRuby::SimpleFeatures::Geometry.from_hex_ewkb(@geometry_as_hex_ewkb) if (!@geometry.nil? && !@geometry_as_hex_ewkb.nil?)
+      @geometry
+    end
+    
+    def geometry_geo_json
+      unless (geometry.nil?)
+        if geometry.is_a? GeoRuby::SimpleFeatures::MultiPolygon
+          geo = TempGeometry.create(:polygon=>geometry) 
+        else
+          geo = TempGeometry.create(:point=>geometry) 
+        end
+        geo.save!
+        json = geo.get_json
+        geo.destroy
+        json
+      end
+      
+    end
+    
+    def get_obj_attributes(attr)
+      if attr == "wdpa_code"
+        return self.site
+      elsif attr == "geometry"
+        return self.geometry_as_hex_ewkb
+      else
+        return self.send(attr)
+      end
+    end
+    
+    #returns printable attributes
+    def get_nonnil_writable_attribute(attr)
+      if @@simple_atts.count(attr) > 0
+        return self.send(attr)
+      elsif attr == "iucn_category"
+        return iucn_category ? iucn_category.name : ""
+      elsif attr == "designation"
+        return designation ? designation.name : ""
+      elsif attr == "legal_status"
+        return legal_status ? legal_status.name : ""
+      elsif attr == "countries"
+        return countries.length > 0 ? countries.collect{|a| a.iso+", "}.to_s.chop.chop : ""
+      elsif attr == "citation"
+        return self.dataset.citation
+      elsif attr == "author"
+        return self.dataset.author
+      elsif attr == "wdpa_code"
+        return self.site.id
+      end
+      return ""
+    end
+    
+    
+    def self.get_by_id(id, has_geom=true)
+      if id.to_i != 0
+        path = "/api/protected_area/#{id}"
+        path = path + "?has_geometry=true" if has_geom
+        res, data = ::DR::Config.http.get(path)
+        return ProtectedArea.parse(data) unless data.nil? || data.empty?
+      end    
+      return nil
+    end
+    
+    
+    def self.exists?(id)
+      !self.get_by_id(id).nil?
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "protected-area"}.merge(options))
+    end
+  end
+end

data/lib/ppe_api/region.rb

@@ -0,0 +1,16 @@
+module PPE_API
+  class Region
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :name, String
+    element :code, String
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "region"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/search.rb

@@ -0,0 +1,5 @@
+module PPE_API
+  class Search 
+    
+  end
+end

data/lib/ppe_api/site.rb

@@ -0,0 +1,31 @@
+module PPE_API
+  class Site 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :abstract_pa_id, Integer
+    element :state, String  
+    
+    def self.get_by_id(id)
+      res, data = ::DR::Config.http.get("/api/site/#{id}")
+      return Site.parse(data) unless data.nil? || data.empty?
+      return nil
+    end
+    
+    def self.exists?(id)
+      return !self.get_by_id(id).nil?
+    end
+    
+    def ==(site)
+      return false if site.nil?
+      return self.id==site.id
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "site"}.merge(options))
+    end
+    
+  end
+end

data/lib/ppe_api/user.rb

@@ -0,0 +1,40 @@
+module PPE_API
+  class User 
+    include ::HappyMapper
+    
+    element :id, Integer
+    element :created_at, DateTime, :tag=>'created-at'
+    element :updated_at, DateTime, :tag=>'updated-at'
+    element :title, String
+    element :first_name, String
+    element :last_name, String
+    element :organization, String
+    element :username, String
+    element :email, String
+    
+    
+    def exports
+      Export.find_all_by_user_id(id)
+    end
+    
+    
+    def completed_tasks  
+      exports.inject(0) do |sum,ex| 
+        if ex.task_status == DR::Config.import_state_map[:completed]
+          sum+=1 
+        end
+        sum
+      end    
+    end  
+    
+    def imports
+      Import.find_all_by_user_id(id)
+    end
+    
+    def to_xml(options={})
+      self.as_json.to_xml({:root => "user"}.merge(options))
+    end
+    
+    
+  end
+end

data/lib/ppe_api.rb

@@ -0,0 +1,17 @@
+require 'happymapper'
+require 'ppe_api/abstract_pa'
+require 'ppe_api/alternative_name'
+require 'ppe_api/apa_relation'
+require 'ppe_api/country'
+require 'ppe_api/dataset'
+require 'ppe_api/designation'
+require 'ppe_api/iucn_category'
+require 'ppe_api/jurisdiction'
+require 'ppe_api/language'
+require 'ppe_api/legal_status'
+require 'ppe_api/point_geom'
+require 'ppe_api/protected_area'
+require 'ppe_api/region'
+require 'ppe_api/search'
+require 'ppe_api/site'
+require 'ppe_api/user'

data/test/factories.rb

@@ -0,0 +1,106 @@
+Factory.define :abstract_pa, :default_strategy => :build do |t|
+end
+
+Factory.define :designation, :default_strategy => :build do |t|
+  t.name "World Heritage Site"
+end
+
+Factory.define :iucn_category, :default_strategy => :build do |t|
+  t.name "Ia"
+  t.value 1
+end
+
+Factory.define :legal_status, :default_strategy => :build do |t|
+  t.name "created"
+end
+
+Factory.define :country, :default_strategy => :build do |t|
+  t.name "United Kingdom"
+  t.iso "GB"
+  t.iso_3 "GBR"
+  t.association :region
+end
+
+Factory.define :region, :default_strategy => :build do |t|
+  t.name "Europe"
+  t.code "EU"
+end
+
+
+
+
+Factory.define :polygon_geom, :default_strategy => :build do |t|
+  t.the_geom MultiPolygon.from_polygons([Polygon.from_coordinates([[[12.4,-45.3],[45.4,41.6],[4.456,1.0698],[12.4,-45.3]],[[2.4,5.3],[5.4,1.4263],[14.46,1.06],[2.4,5.3]]]),Polygon.from_coordinates([[[0,0],[4,0],[4,4],[0,4],[0,0]],[[1,1],[3,1],[3,3],[1,3],[1,1]]])], 4326)
+end
+
+Factory.define :point_geom, :default_strategy => :build do |t|
+  t.the_geom Point.from_coordinates([1,2], 4326)
+end
+
+Factory.define :dataset,  :default_strategy => :build do |t|
+  t.citation "Some dataset name"
+  t.author "Galt, J. & Timmy, L."
+  t.association :user
+end
+
+Factory.define :user, :default_strategy => :build do |t|
+  t.title "Mr"
+  t.first_name "simon"
+  t.last_name "tokumine"
+  t.sequence(:username) {|n| "simon#{n}"} 
+  t.sequence(:email) {|n| "simon#{n}@tokumine.com"} 
+  t.password "secret"
+  t.password_confirmation "secret"
+  t.first_login_ip "88.96.173.198" 
+  t.latitude 53.6167
+  t.longitude -2.15
+  t.association :country
+end
+
+Factory.define :species, :default_strategy => :build do |t|
+  t.name "elephant"
+  t.url "http://somwere.com"
+  t.association :site
+end
+
+Factory.define :point_of_interest, :default_strategy => :build do |t|
+  t.title "waterfall"
+  t.summary "nice waterfall"
+  t.url "http://www.google.com"
+end
+
+Factory.define :image, :default_strategy => :build do |u|
+  u.photo { ActionController::TestUploadedFile.new(File.join(RAILS_ROOT, 'test', 'resources', 'chewie.jpg')) }  
+end
+
+Factory.define :image_han, :class => :image, :default_strategy => :build do |u|
+  u.photo { ActionController::TestUploadedFile.new(File.join(RAILS_ROOT, 'test', 'resources', 'han.jpg')) }  
+end
+
+Factory.define :site, :default_strategy => :build do |t|
+  t.association :abstract_pa
+end
+
+Factory.define :protected_area, :default_strategy => :build  do |t|
+  t.state "complete"
+  t.english_name "Yosemite"
+  t.local_name "Yosemite"
+  t.total_area 123123
+  t.total_area_marine 32432
+  t.status_date 10.years.ago
+  t.legally_extended true
+  t.legally_reduced false
+  t.legally_reclassified false
+  t.association :site
+  t.association :designation
+  t.association :iucn_category
+  t.association :legal_status
+  t.association :polygon_geom
+  t.association :point_geom
+  t.association :dataset 
+  t.association :user   
+end
+
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,62 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end
+
+class PGconn
+  def PGconn.quote_ident(name)
+      %("#{name}")
+  end
+end
+
+class Test::Unit::TestCase
+  def self.should_have_attached_file(attachment)
+    klass = self.name.gsub(/Test$/, '').constantize
+
+    context "To support a paperclip attachment named #{attachment}, #{klass}" do
+      should_have_db_column("#{attachment}_file_name",    :type => :string)
+      should_have_db_column("#{attachment}_content_type", :type => :string)
+      should_have_db_column("#{attachment}_file_size",    :type => :integer)
+    end
+
+    should "have a paperclip attachment named ##{attachment}" do
+      assert klass.new.respond_to?(attachment.to_sym), 
+             "@#{klass.name.underscore} doesn't have a paperclip field named #{attachment}"
+      assert_equal Paperclip::Attachment, klass.new.send(attachment.to_sym).class
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: ppe_api
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Liz Schwartz
+autorequire: data_rec_gem
+bindir: bin
+cert_chain: []
+
+date: 2009-12-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: happymapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ppe_api/abstract_pa.rb
+- lib/ppe_api/alternative_name.rb
+- lib/ppe_api/apa_relation.rb
+- lib/ppe_api/country.rb
+- lib/ppe_api/dataset.rb
+- lib/ppe_api/designation.rb
+- lib/ppe_api/iucn_category.rb
+- lib/ppe_api/jurisdiction.rb
+- lib/ppe_api/language.rb
+- lib/ppe_api/legal_status.rb
+- lib/ppe_api/point_geom.rb
+- lib/ppe_api/polygon_geom.rb
+- lib/ppe_api/protected_area.rb
+- lib/ppe_api/region.rb
+- lib/ppe_api/search.rb
+- lib/ppe_api/site.rb
+- lib/ppe_api/user.rb
+- lib/ppe_api.rb
+- test/factories.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A package for reading ppe api requests
+test_files: []
+