open311-validator 0.0.1

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2011 SeeClickFix
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.markdown

@@ -0,0 +1,7 @@
+Tools to Validate311
+====================================
+
+Running
+----------
+
+Install HTTParty gem. Run using command 'ruby bin/validate'

data/bin/open311-validate

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+#
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'optparse'
+require 'validate_311'
+
+options = {  :discovery_url   => 'http://seeclickfix.com/open311/discovery', 
+             :production      => false,
+             :write           => false
+           }
+           
+      
+ op = OptionParser.new do |opts|
+   opts.banner = "Usage: validate [options]"
+   opts.on('-u', '--url [discovery_url]','') do |url|
+     options[:discovery_url] = url if url
+   end
+   opts.on('-p', '--production [true/false]', 'Default: false') do |resp|
+     options[:production] = resp unless resp.nil?
+   end
+   opts.on('-k', '--api_key [key]', 'Default: none') do |resp|
+     options[:api_key] = resp unless resp.nil?
+   end
+   opts.on('-w', '--write [true/false]', 'Default: false') do |resp|
+     options[:write] = resp unless resp.nil?
+   end
+   opts.on('-j', '--jurisdiction_id [jurisdiction_id]', 'Default: none') do |resp|
+     options[:jurisdiction_id] = resp unless resp.nil?
+   end
+   opts.on('-a', '--address [address]', 'Default: none') do |resp|
+     options[:address] = resp unless resp.nil?
+   end
+
+ end
+ op.parse!
+           
+@session = Session.new(options)
+@session.valid? ? @session.run_tests : (puts op)

data/lib/client.rb

@@ -0,0 +1,70 @@
+
+
+class Client
+  attr_accessor :raw, :base, :format, :unwrap
+
+  def initialize(base,format)
+    @base = base
+    @format = format
+  end
+  
+  def get_and_unwrap(url,unwrap)
+    @unwrap = unwrap
+    get(url)
+  end
+
+  def get(url)
+    @raw = HTTParty.get("#{@base}#{url}")
+    self
+  end
+  
+  def post(url,body)
+    # TODO: remove. This is simply for my testing.
+    url = 'http://localhost:3000/open311/requests.xml'
+    @raw = HTTParty.post(url, :body => body)
+    self
+  end
+  
+  def response
+    if @format == 'xml' and !@unwrap.nil?
+      Array(Session.unwrap(raw_response,@unwrap))
+    else
+      raw_response
+    end
+  end
+  
+  def raw_response
+    Client.hash2ostruct(@raw.parsed_response)
+  end
+  
+  def headers
+    Client.hash2ostruct(@raw.headers)
+  end
+  
+  def body
+    @raw.body
+  end
+  
+  def request
+    @raw.request
+  end
+  
+  # Recursively create ostruct obj from 
+  # httparty's Hash/Array mess.
+  def self.hash2ostruct(object)
+    return case object
+    when Hash
+      object = object.clone
+      object.each do |key, value|
+        object[key] = Client.hash2ostruct(value)
+      end
+      OpenStruct.new(object)
+    when Array
+      object = object.clone
+      object.map! { |i| Client.hash2ostruct(i) }
+    else
+      object
+    end
+  end
+  
+end

data/lib/resource.rb

@@ -0,0 +1,98 @@
+
+
+class Resource
+  attr_accessor :options, :raw
+  
+  def initialize(session,options)
+    @options = options
+    @session = session
+    @last_resource = session.resource
+  end
+  
+  def get_next
+    self.send @options[:with]
+  end
+  
+  def discovery_url
+    @raw = OpenStruct.new
+    @raw.json = Client.new(@options[:discovery_url],'json').get(".json")
+    @raw.xml  = Client.new(@options[:discovery_url],'xml').get(".xml")
+  end
+
+  def services_resource
+    @raw = []
+    @session.endpoint_array.each do |endpoint|
+      response = Client.new(endpoint[0],endpoint[1])
+      response.get_and_unwrap("/services.#{endpoint[1]}?jurisdiction_id=#{@options[:jurisdiction_id]}",'services.service')
+      @raw << response
+    end
+  end
+  
+  def definition_resource
+    @raw = []
+    @session.raw_services.each do |raw_service|
+      raw_service.response.each do |service|
+        next if !service.metadata or service.metadata == 'false'
+        response = Client.new(raw_service.base,raw_service.format)
+        response.get_and_unwrap("/services/#{service.service_code}.#{raw_service.format}?jurisdiction_id=#{@options[:jurisdiction_id]}",'')
+        @raw << response
+      end
+    end
+  end
+  
+  # 
+  # Purpose: Create service requests
+  # URL: https://[API endpoint]/requests.[format]
+  # Sample URL: https://api.city.gov/dev/v2/requests.xml
+  # Format sent: Content-Type: application/x-www-form-urlencoded
+  # Formats returned: XML (JSON available if denoted by Service Discovery)
+  # HTTP Method: POST
+  # Requires API Key: Yes
+  #
+  #
+  # Required Arguments
+  # jurisdiction_id
+  # service_code (obtained from GET Service List method)
+  # location: either lat & long or address_string or address_id must be submitted
+  # attribute - only required if the service_code requires a service definition with required fields
+  # Explanation: An array of key/value responses based on Service Definitions. This takes the form of attribute[code]=value where multiple code/value pairs can be specified as well as multiple values for the same code in the case of a multivaluelist datatype (attribute[code1][]=value1&attribute[code1][]=value2&attribute[code1][]=value3) - see example
+  # 
+  def create_resource_once
+    @raw.xml  = []
+    @raw.json = []
+    # For each endpoint...
+    @session.discovery.xml.response.discovery.endpoints.endpoint.each do |endpoint|
+      next if type(endpoint) == 'production' and !@options.production
+      @raw.xml << Client.new.post("#{endpoint.url}/requests.xml",data_from_options)
+    end
+    
+    @session.discovery.json.response.endpoints.each do |endpoint|
+      next if type(endpoint) == 'production' and !@options.production
+      @raw.json << Client.new.post("#{endpoint.url}/requests.json",data_from_options)
+    end if @options.json
+    
+    @raw.options = @options
+    @raw
+  end
+  
+  def data_from_options
+    ## Converting @options back to a hash and merge them with user-supplied
+    #  post data.
+    { :api_key => @options.api_key,
+      :jurisdiction_id => @options.jurisdiction_id,
+      :service_code => first_service_code,
+      :address_string => @options.address
+    }.merge!(@options.post)
+  end
+  
+  def first_service_code
+    @session.resources[1].xml.first.response.services.service.service_code
+  end
+  
+
+  
+  private
+  
+
+  
+end

data/lib/ruby_spec.rb

@@ -0,0 +1,75 @@
+
+# class PositiveSpec
+#   def initialize(obj,required)
+#     @obj = obj
+#     @required = required
+#   end
+#   
+#   def ==(other)
+#     if @obj != other
+#       raise Exception.new("#{requirement}: \"Expected: #{other} Got: #{@obj}\"")
+#     end
+#   end
+# 
+#   def >(other)
+#     unless @obj > other
+#       raise Exception.new("#{requirement}: \"Expected: #{other} Got: #{@obj}\"")
+#     end
+#   end
+#   
+#   def requirement
+#     @required ? "REQUIRED" : "WARNING"
+#   end
+# end
+
+# class NegativeSpec
+#   def initialize(obj,required)
+#     @obj = obj
+#     @required = required
+#   end
+#   
+#   def ==(other)
+#     if @obj == other
+#       raise Exception.new("#{requirement}: \"Expected: #{other} Got: #{@obj}\"")
+#     end
+#   end
+#   
+#   def requirement
+#     @required ? "REQUIRED" : "WARNING"
+#   end
+# end
+
+# class Object
+#   def should
+#     PositiveSpec.new(self,false)
+#   end
+#   
+#   def should_not
+#     NegativeSpec.new(self,false)
+#   end
+#   
+#   def must
+#     RequiredPositiveSpec.new(self,true)
+#   end
+#   
+#   def must_not
+#     RequiredNegativeSpec.new(self,true)
+#   end
+# end
+
+
+def rule(msg)
+  begin
+    yield
+    print "    #{msg.to_s.lstrip.ljust(90)[0..70]}","PASSED"
+  rescue Exception => e
+    print "    #{msg.to_s.lstrip.ljust(90)[0..70]}","FAILED  #{e.to_s}"
+  end
+  puts ""
+end
+
+def test(msg,options)
+  puts "  Testing - #{msg.to_s}"
+  @session.add_resource(options)
+  yield
+end

data/lib/session.rb

@@ -0,0 +1,106 @@
+
+class Session
+  attr_accessor :options
+  
+  def initialize(options)
+    @resources = []
+    @options   = {
+      :production => false,
+      :write      => false
+    }.merge options
+  end
+  
+  def run_tests
+    load 'tests/discovery.rb'
+    load 'tests/services.rb'
+    load 'tests/service_definition.rb'
+    load 'tests/create.rb' if @options[:write]
+  end
+  
+  def valid?
+    @options[:discovery_url] && 
+    !@options[:production].nil? &&
+    !@options[:write].nil? &&
+    !@options[:production].nil? &&
+    (!@options[:write] || ( @options[:write] && !@options[:address].nil? ))
+  end
+  
+  #
+  #  Resource mgmt.
+  def add_resource(options)
+    resource = Resource.new(self,@options.merge(options))
+    resource.get_next
+    @resources << resource
+  end
+  
+  def resources
+    @resources
+  end
+  
+  def discovery
+    @resources.first
+  end
+  
+  def resource
+    @resources.last
+  end
+  
+  # Endpoint mgmt.
+  def endpoint_array
+    t = []
+    all_endpoints.each do |endpoint|
+      Session.endpoint_formats_as_array(endpoint).each do |format|
+        next if format =~ /^.*html$/i
+        t << [endpoint.url,format]
+      end
+    end
+    t
+  end
+  
+  def self.endpoint_formats_as_array(endpoint)
+    Session.endpoint_formats(endpoint).map{|format| format.to_s.split('/')[1]}
+  end
+  
+  def self.endpoint_formats(endpoint)
+    endpoint.formats.is_a?(Array) ? endpoint.formats : Array(Session.unwrap(endpoint,'formats.format'))
+  end
+  
+  def all_endpoints
+    json_endpoints + xml_endpoints
+  end
+  
+  def json_endpoints
+    Session.unwrap(discovery.raw.json, 'response.endpoints').select{|endpoint| production_safe?(endpoint) }
+  end
+  
+  def xml_endpoints
+    Array(Session.unwrap(discovery.raw.xml,'response.discovery.endpoints.endpoint')).select{|endpoint| production_safe?(endpoint) }
+  end
+  
+  #
+  #  Services Lookup
+  #
+  def services
+    @resources[1].raw.map{|r| r.response }.flatten
+  end
+  
+  def raw_services
+    @resources[1].raw
+  end
+  
+  # Class Methods
+  def self.unwrap(obj,methods)
+    methods.split('.').each do |method|
+      obj = obj.send method.to_sym
+    end
+    obj
+  end
+  
+  private
+  
+  # The marshal_dump is to avoid calling .type on the obj.
+  def production_safe?(endpoint)
+    endpoint.marshal_dump[:type] != 'production' or @options[:production]
+  end
+  
+end

data/lib/test_helper.rb

@@ -0,0 +1,37 @@
+
+module TestHelper
+
+  def validate_date_time(time)
+    time.is_a?(Time) ? time : Time.iso8601(time) rescue false
+  end
+  
+  def resource
+    @session.resource
+  end
+  
+  def xml_endpoints
+    @session.discovery.raw.xml.response.discovery.endpoints.endpoint
+  end
+  
+  def json_endpoints
+    @session.discovery.raw.json.response.endpoints
+  end
+  
+  def all_endpoints
+    xml_endpoints + json_endpoints
+  end
+  
+  def v2_endpoints
+    all_endpoints.select{|endpoint| endpoint.specification =~ /^.*_v2$/i }
+  end
+  
+  def xml_discovery
+    @session.discovery.raw.xml.response.discovery
+  end
+  
+  def json_discovery
+    @session.discovery.raw.json.response
+  end
+
+  extend self
+end

data/lib/validate_311.rb

@@ -0,0 +1,11 @@
+
+
+require 'client'
+require 'session'
+require 'resource'
+require 'ruby_spec'
+
+require 'rubygems'
+require 'ostruct'
+require 'httparty'
+require 'rspec'

data/tests/create.rb

@@ -0,0 +1,29 @@
+
+
+  #  @session.resources  = History of resources for entire session of tests.
+  #  @resource = currently tested resource.
+  #  @resource.options  = options used for that resource
+  #  @resource.json.response = objectified response
+  #  @resource.json.headers = response headers
+  #  @resource.json.body = response body
+  #  @resource.json.request = httparty request object
+  #
+  #
+
+data = { :email => 'foo@bar.com', :description => 'I know' }
+
+test "Creating Client Once", { :with => :create_resource_once, :post => data } do
+  
+  rule 'each should return something' do 
+    @resource.xml.each do |request|
+      request.response.should_not == ''
+    end
+    
+    if @resource.options.json
+      @resource.json.each do |request|
+        request.response.should_not == ''
+      end
+    end
+  end
+  
+end

data/tests/discovery.rb

@@ -0,0 +1,105 @@
+require 'test_helper';include TestHelper  
+
+test "Service Discovery", :with => :discovery_url do
+  
+  rule 'url should end with "discovery"' do 
+    resource.options[:discovery_url][-9..-1].should == 'discovery'
+  end
+  
+  rule 'both formats should return results' do 
+     resource.raw.xml.to_s.strip.should_not == '' && resource.raw.json.to_s.strip.should_not == ''
+  end  
+  
+  rule 'both formats should have contacts' do 
+     xml_discovery.contact.to_s.strip.should_not == ''
+     json_discovery.contact.to_s.strip.should_not == ''
+  end
+  
+  rule 'both formats should have key_service information' do 
+     xml_discovery.key_service.to_s.strip.should_not == ''
+     json_discovery.key_service.to_s.strip.should_not == ''
+  end
+  
+  rule 'return valid DateTime objects' do 
+    validate_date_time(xml_discovery.changeset).class.should == Time
+    validate_date_time(json_discovery.changeset).class.should == Time
+  end
+    
+  rule "contacts should return same for both formats" do 
+    xml_discovery.contacts.should == json_discovery.contacts
+  end
+  
+  rule "xml endpoint should be an array" do
+    xml_endpoints.class.should == Array
+  end
+  
+  rule "there should be at least one endpoint" do
+    xml_endpoints.size.should > 0
+  end
+  
+  rule "each endpoint should have a specification" do 
+    all_endpoints.each do |endpoint|
+      endpoint.specification.should_not == ''
+    end
+  end
+  
+  rule "each endpoint should have a url" do 
+    all_endpoints.each do |endpoint|
+      endpoint.url.should_not == ''
+    end
+  end
+  
+  rule "each endpoint should have a changeset" do 
+    all_endpoints.each do |endpoint|
+      endpoint.changeset.should_not == ''
+    end
+  end
+  
+  rule "each endpoint should have a valid changeset" do 
+    all_endpoints.each do |endpoint|
+      validate_date_time(endpoint.changeset).class.should == Time
+    end
+  end
+  
+  rule "each endpoint should have a changeset in the past" do 
+    all_endpoints.each do |endpoint|
+      validate_date_time(endpoint.changeset).should < Time.now
+    end
+  end
+  
+  rule "each endpoint should have a type" do 
+    all_endpoints.each do |endpoint|
+      endpoint.marshal_dump[:type].should_not == ''
+    end
+  end
+  
+  rule "each endpoint should have an array of formats" do 
+    xml_endpoints.each do |endpoint|
+      endpoint.formats.format.class.should == Array
+    end
+    json_endpoints.each do |endpoint|
+      endpoint.formats.class.should == Array
+    end
+  end
+  
+  rule "each endpoint should have at least one supported format" do 
+    all_endpoints.each do |endpoint|
+      Session.endpoint_formats(endpoint).size.should > 0
+    end
+  end
+  
+  rule "all v2 endpoints should support xml" do
+    v2_endpoints.each do |endpoint|
+      Session.endpoint_formats(endpoint).select{|format| format == 'text/xml' }.size.should > 0
+    end
+  end
+  
+end
+
+
+
+
+
+
+
+

data/tests/service_definition.rb

@@ -0,0 +1,11 @@
+require 'test_helper';include TestHelper 
+
+test "Service Definitions", :with => :definition_resource do
+  
+  rule 'test resource' do
+    # raise @session.resource.raw.inspect
+    # raise @session.prev_resource.inspect
+    # raise @resource.xml.inspect
+  end
+  
+end

data/tests/services.rb

@@ -0,0 +1,18 @@
+require 'test_helper';include TestHelper 
+
+
+test "Services", :with => :services_resource do
+  
+  rule 'there should be at least one service right?' do 
+    @session.raw_services.each do |services| 
+      services.response.size.should > 0
+    end
+  end
+  
+  rule 'all services should have a service code' do
+    @session.services.each do |service|
+      service.service_code.should_not == nil
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: open311-validator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- SeeClickFix (Jeff Blasius)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A command line Open311 validator. (http://open311.org)
+email: dev@seeclickfix.com
+executables: 
+- open311-validate
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.markdown
+- bin/open311-validate
+- lib/client.rb
+- lib/resource.rb
+- lib/ruby_spec.rb
+- lib/session.rb
+- lib/test_helper.rb
+- lib/validate_311.rb
+- tests/create.rb
+- tests/discovery.rb
+- tests/service_definition.rb
+- tests/services.rb
+homepage: http://github.com/seeclickfix/open311-validator
+licenses: []
+
+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: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Open311 Validator
+test_files: []
+