granicus-platform-api 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gem_template.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    granicus-platform-api (0.1.0)
+      hashie (~> 1.0.0)
+      multi_xml (~> 0.2.2)
+      savon (~> 0.9.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    hashie (1.0.0)
+    httpi (0.9.4)
+      pyu-ntlm-http (>= 0.1.3.1)
+      rack
+    multi_xml (0.2.2)
+    nokogiri (1.4.4)
+    nori (1.0.1)
+    pyu-ntlm-http (0.1.3.1)
+    rack (1.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    savon (0.9.2)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (>= 0.7.8)
+      nokogiri (>= 1.4.0)
+      nori (>= 0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  granicus-platform-api!
+  hashie (~> 1.0.0)
+  multi_xml (~> 0.2.2)
+  rspec (~> 2.6)
+  savon (~> 0.9.2)

data/README.rdoc

@@ -0,0 +1,59 @@
+= Overview
+
+== About Granicus Platform API
+
+Granicus is a platform for government transparency and citizen engagement in use by over 900 government organizations, from small towns to the US Congress.  This Ruby wrapper allows for integration with the SOAP web service that can be used to automate backend tasks in the system.
+
+== WARNING
+
+This gem is still under heavy development, and is not recommended for production use. Contributions and suggestions are welcome.
+
+== Usage
+
+First:
+
+<tt>gem install granicus-platform-api</tt>
+
+Then create a client:
+
+<tt>granicus = GranicusPlatformAPI::Client.new(<customer site>,<username>,<password>)</tt>
+
+Granicus site is, for instance, sanfrancisco.granicus.com. Username and password must be a valid username/password for the site. This API is not for public access. If you wish to gain access to an API for public access, join the Granicus Developers Google Group.
+
+Once you have initialized your client, you can make calls to the documented API methods. The only difference is that you will use snake_case methods and properties rather than CamelCase ones. For example:
+
+<tt>clips = granicus.get_clips</tt>
+
+== Compatibility
+
+This wrapper is developed against 1.9.2.
+
+= License
+
+Copyright (c) 2011 Javier Muniz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+You will notify the author and give permission to have your software
+listed on this and other websites of the author as using the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+= Credits
+
+Javier Muniz

data/granicus-platform-api.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "granicus-platform-api/version"
+
+Gem::Specification.new do |s|
+  s.name = "granicus-platform-api"
+  s.version     = GranicusPlatformAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors = ["Javier Muniz"]
+  s.email = "javier@granicus.com"
+  s.summary = "Granicus Open Platform API 1.x Wrapper"
+  s.homepage = "http://github.com/gov20cto/granicus-platform-api"
+  s.description = "Wrapper for the Granicus Open Platform API v1.x"
+  
+  s.rubyforge_project = "granicus-platform-api"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency('rspec', '~> 2.6')
+  s.add_development_dependency('hashie', '~> 1.0.0')
+  s.add_development_dependency('savon', '~> 0.9.2')
+  s.add_development_dependency('multi_xml', '~> 0.2.2')
+  
+  s.add_dependency('savon', '~> 0.9.2')
+  s.add_dependency('hashie', '~> 1.0.0')
+  s.add_dependency('multi_xml', '~> 0.2.2')
+end

data/lib/granicus-platform-api/client.rb

@@ -0,0 +1,291 @@
+require 'savon'
+require 'hashie'
+require 'multi_xml'
+
+module GranicusPlatformAPI
+  class Client
+
+    # create a connected client
+    def initialize(granicus_site,username,password,options={})
+      # set things up
+      @granicus_site = granicus_site
+      Savon.configure do |config|
+        config.log = false
+      end
+      HTTPI.log = false
+
+      # create the client
+      @client = Savon::Client.new do |wsdl, http|
+        wsdl.document = File.expand_path("../granicus-platform-api.xml", __FILE__)
+        wsdl.endpoint = "http://#{granicus_site}/SDK/User/index.php" 
+        http.proxy = "http://localhost:8888"
+
+      end
+
+      # call login
+      @client.request :wsdl, :login do
+        soap.body = { :username => username, :password => password }
+      end
+
+    end
+
+    # return the current logged on user name
+    def get_current_user_logon
+      response = @client.request :wsdl, :get_current_user_logon
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns4:GetCurrentUserLogonResponse/Logon', doc.root.namespaces)[0]
+    end
+
+    # logout
+    def logout
+      response = @client.request :wsdl, :logout
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns4:LogoutResponse', doc.root.namespaces)[0]
+    end
+
+    # return all of the cameras
+    def get_cameras
+      response = @client.request :wsdl, :get_cameras
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetCamerasResponse/cameras', doc.root.namespaces)[0]
+    end
+    
+    # return the requested event
+    def get_camera(camera_id)
+      response = @client.request :wsdl, :get_camera do
+        soap.body = { :camera_id => camera_id, :attributes! => {:camera_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetCameraResponse/camera', doc.root.namespaces)[0]
+    end
+
+    # return all of the events
+    def get_events
+      response = @client.request :wsdl, :get_events
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetEventsResponse/events', doc.root.namespaces)[0]
+    end
+    
+    # return all of the events with matching foreign id
+    def get_events_by_foreign_id(foreign_id)
+      response = @client.request :wsdl, :get_events_by_foreign_id do
+        soap.body = { :foreign_id => foreign_id, :attributes! => {:foreign_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetEventsByForeignIDResponse/events', doc.root.namespaces)[0]
+    end
+    
+    # return the requested event
+    def get_event(event_id)
+      response = @client.request :wsdl, :get_event do
+        soap.body = { :event_id => event_id, :attributes! => {:event_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetEventResponse/event', doc.root.namespaces)[0]
+    end
+
+    # return all of the event meta data
+    def get_event_meta_data(event_id)
+      response = @client.request :wsdl, :get_event_meta_data do
+        soap.body = { :event_id => event_id, :attributes! => {:event_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetEventMetaDataResponse/metadata', doc.root.namespaces)[0]
+    end
+    
+    # set the event agenda url
+    def set_event_agenda_url(event_id,url)
+      response = @client.request :wsdl, :set_event_agenda_url do
+        soap.body = { :event_id => event_id, 
+                      :url => url, 
+                      :attributes! => {:event_id => {"xsi:type" => "xsd:int"}, :url => {"xsi:type" => "xsd:string"}} }
+      end
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns4:SetEventAgendaURLResponse', doc.root.namespaces)[0]
+    end
+    
+    # return all of the clip meta data
+    def get_clip_meta_data(clip_id)
+      response = @client.request :wsdl, :get_clip_meta_data do
+        soap.body = { :clip_id => clip_id, :attributes! => {:clip_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetClipMetaDataResponse/metadata', doc.root.namespaces)[0]
+    end
+
+    # return all of the folders
+    def get_folders
+      response = @client.request :wsdl, :get_folders
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetFoldersResponse/folders', doc.root.namespaces)[0]
+    end
+
+    # return all of the clips
+    def get_clips(folder_id)
+      response = @client.request :wsdl, :get_clips do
+        soap.body = { :folder_id => folder_id, :attributes! => {:folder_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetClipsResponse/clips', doc.root.namespaces)[0]
+    end
+    
+    # return all of the clips with matching foreign id
+    def get_clips_by_foreign_id(foreign_id)
+      response = @client.request :wsdl, :get_clips_by_foreign_id do
+        soap.body = { :foreign_id => foreign_id, :attributes! => {:foreign_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetClipsByForeignIDResponse/clips', doc.root.namespaces)[0]
+    end
+    
+    # return the requested clip
+    def get_clip(clip_id)
+      response = @client.request :wsdl, :get_clip do
+        soap.body = { :clip_id => clip_id, :attributes! => {:clip_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetClipResponse/clip', doc.root.namespaces)[0]
+    end
+    
+    # return the requested clip
+    def get_clip_by_uid(clip_uid)
+      response = @client.request :wsdl, :get_clip_by_uid do
+        soap.body = { :clip_uid => clip_uid, :attributes! => {:clip_uid => {"xsi:type" => "xsd:string"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetClipByUIDResponse/clip', doc.root.namespaces)[0]
+    end
+
+    # get servers
+    def get_servers
+      response = @client.request :wsdl, :get_servers
+      
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetServersResponse/servers', doc.root.namespaces)[0]
+    end
+    
+    # return the requested server
+    def get_server(server_id)
+      response = @client.request :wsdl, :get_server do
+        soap.body = { :server_id => server_id, :attributes! => {:server_id => {"xsi:type" => "xsd:int"}} }
+      end
+
+      doc = Nokogiri::XML(response.to_xml) do |config|
+        config.noblanks
+      end
+      typecast_value_node doc.xpath('//ns5:GetServerResponse/server', doc.root.namespaces)[0]
+    end
+
+    private
+
+    def typecast_value_node(node)
+      if node.is_a? Nokogiri::XML::NodeSet or node.is_a? Array then
+        return node.map {|el| typecast_value_node el } 
+      end
+      return node.to_s unless node['type'] 
+      typespace,type = node['type'].split(':')
+      case typespace
+      when 'xsd'
+        proc = self.class.typecasts[type]
+        unless proc.nil?
+          proc.call(node.children[0].to_s)
+        else
+          puts "Unknown xsd:type: #{type}"
+          node.children[0].to_s
+        end
+      when 'SOAP-ENC'
+        if type == 'Array' then
+          node.children.map {|element| typecast_value_node element }
+        else
+          puts "Unknown SOAP-ENC:type: #{type}"
+          node.to_s
+        end
+      else
+        # we have a custom type, make it hashie since we don't want true static typing
+        value = ::Hashie::Mash.new
+        node.children.each do |value_node|
+          value[value_node.name.snakecase] = typecast_value_node value_node
+        end
+        value
+      end
+    end
+    
+    # typecasts ripped from rubiii/nori, adapted for xsd types
+    def self.typecasts
+      @@typecasts
+    end
+
+    def self.typecasts=(obj)
+      @@typecasts = obj
+    end
+
+    def self.available_typecasts
+      @@available_typecasts
+    end
+
+    def self.available_typecasts=(obj)
+      @@available_typecasts = obj
+    end
+
+    self.typecasts = {}
+    self.typecasts["int"] = lambda { |v| v.nil? ? nil : v.to_i }
+    self.typecasts["boolean"] = lambda { |v| v.nil? ? nil : (v.strip != "false") }
+    self.typecasts["datetime"] = lambda { |v| v.nil? ? nil : Time.parse(v).utc }
+    self.typecasts["date"] = lambda { |v| v.nil? ? nil : Date.parse(v) }
+    self.typecasts["dateTime"] = lambda { |v| v.nil? ? nil : Time.parse(v).utc }
+    self.typecasts["decimal"] = lambda { |v| v.nil? ? nil : BigDecimal(v.to_s) }
+    self.typecasts["double"] = lambda { |v| v.nil? ? nil : v.to_f }
+    self.typecasts["float"] = lambda { |v| v.nil? ? nil : v.to_f }
+    self.typecasts["symbol"] = lambda { |v| v.nil? ? nil : v.to_sym }
+    self.typecasts["string"] = lambda { |v| v.to_s }
+    self.typecasts["yaml"] = lambda { |v| v.nil? ? nil : YAML.load(v) }
+    self.typecasts["base64Binary"] = lambda { |v| v.unpack('m').first }
+
+    self.available_typecasts = self.typecasts.keys
+    
+  end
+end