granicus-platform-api 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    granicus-platform-api (0.1.0)
+    granicus-platform-api (0.1.1)
       hashie (~> 1.0.0)
-      multi_xml (~> 0.2.2)
       savon (~> 0.9.2)
 
 GEM
@@ -17,7 +16,6 @@ GEM
     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)
@@ -36,6 +34,9 @@ GEM
       httpi (>= 0.7.8)
       nokogiri (>= 1.4.0)
       nori (>= 0.2.0)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.4)
 
 PLATFORMS
   ruby
@@ -43,6 +44,6 @@ PLATFORMS
 DEPENDENCIES
   granicus-platform-api!
   hashie (~> 1.0.0)
-  multi_xml (~> 0.2.2)
   rspec (~> 2.6)
   savon (~> 0.9.2)
+  simplecov (~> 0.4.0)

data/granicus-platform-api.gemspec

@@ -20,11 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_development_dependency('rspec', '~> 2.6')
+  s.add_development_dependency('simplecov', '~> 0.4.0')
   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

@@ -1,6 +1,4 @@
 require 'savon'
-require 'hashie'
-require 'multi_xml'
 
 module GranicusPlatformAPI
   class Client
@@ -19,9 +17,27 @@ module GranicusPlatformAPI
 
     self.typegenerators = {}
     
+    self.typegenerators["AgendaItem"] = lambda { AgendaItem.new }
+    self.typegenerators["Attendee"] = lambda { Attendee.new }
+    self.typegenerators["AttendeeStatus"] = lambda { AttendeeStatus.new }
     self.typegenerators["CameraData"] = lambda { CameraData.new }
+    self.typegenerators["CaptionData"] = lambda { CaptionData.new }
+    self.typegenerators["ClipData"] = lambda { ClipData.new }
+    self.typegenerators["Document"] = lambda { Document.new }
     self.typegenerators["EventData"] = lambda { EventData.new }
-    self.typegenerators["Attendee"] = lambda { Attendee.new }
+    self.typegenerators["FolderData"] = lambda { FolderData.new }
+    self.typegenerators["GroupData"] = lambda { GroupData.new }
+    self.typegenerators["KeyMapping"] = lambda { KeyMapping.new }
+    self.typegenerators["MetaDataData"] = lambda { MetaDataData.new }
+    self.typegenerators["Motion"] = lambda { Motion.new }
+    self.typegenerators["Note"] = lambda { Note.new }
+    self.typegenerators["Rollcall"] = lambda { Rollcall.new }
+    self.typegenerators["ServerData"] = lambda { ServerData.new }
+    self.typegenerators["ServerInterfaceData"] = lambda { ServerInterfaceData.new }
+    self.typegenerators["TemplateData"] = lambda { TemplateData.new }
+    self.typegenerators["ViewData"] = lambda { ViewData.new }
+    self.typegenerators["VoteEntry"] = lambda { VoteEntry.new }
+    self.typegenerators["VoteRecord"] = lambda { VoteRecord.new }
     
     # classmap for generating proper attributes! hash within savon calls
     def self.classmap
@@ -32,15 +48,36 @@ module GranicusPlatformAPI
       @@classmap = obj
     end
 
+    # built-in types
     self.classmap = {}
     self.classmap['Fixnum'] = "xsd:int"
     self.classmap['String'] = "xsd:string"
     self.classmap['TrueClass'] = 'xsd:boolean'
     self.classmap['FalseClass'] = 'xsd:boolean'
     self.classmap['Time'] = 'xsd:dateTime'
+    
+    # start custom types
+    self.classmap['AgendaItem'] = 'granicus:AgendaItem'
+    self.classmap['Attendee'] = 'granicus:Attendee'
+    self.classmap['AttendeeStatus'] = 'granicus:AttendeeStatus'
     self.classmap['CameraData'] = 'granicus:CameraData'
+    self.classmap['CaptionData'] = 'granicus:CaptionData'
+    self.classmap['ClipData'] = 'granicus:ClipData'
+    self.classmap['Document'] = 'granicus:Document'
     self.classmap['EventData'] = 'granicus:EventData'
-    self.classmap['Attendee'] = 'granicus:Attendee'
+    self.classmap['FolderData'] = 'granicus:FolderData'
+    self.classmap['GroupData'] = 'granicus:GroupData'
+    self.classmap['KeyMapping'] = 'granicus:KeyMapping'
+    self.classmap['MetaDataData'] = 'granicus:MetaDataData'
+    self.classmap['Motion'] = 'granicus:Motion'
+    self.classmap['Note'] = 'granicus:Note'
+    self.classmap['Rollcall'] = 'granicus:Rollcall'
+    self.classmap['ServerData'] = 'granicus:ServerData'
+    self.classmap['ServerInterfaceData'] = 'granicus:ServerInterfaceData'
+    self.classmap['TemplateData'] = 'granicus:TemplateData'
+    self.classmap['ViewData'] = 'granicus:ViewData'
+    self.classmap['VoteEntry'] = 'granicus:VoteEntry'
+    self.classmap['VoteRecord'] = 'granicus:VoteRecord'
     
     # create a connected client
     def initialize(granicus_site,username,password,options={})
@@ -55,7 +92,7 @@ module GranicusPlatformAPI
       @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 = options[:proxy]
+        http.proxy = options[:proxy] if not options[:proxy].nil?
       end
 
       # call login
@@ -77,10 +114,25 @@ module GranicusPlatformAPI
       call_soap_method(:get_cameras,'//ns5:GetCamerasResponse/cameras')
     end
     
-    # return the requested event
+    # create a camera
+    def create_camera(camera)
+      call_soap_method(:create_camera,'//ns4:CreateCameraResponse/CameraID',{ :camera_data => camera })
+    end
+    
+    # return the requested camera
     def get_camera(camera_id)
       call_soap_method(:get_camera,'//ns5:GetCameraResponse/camera',{ :camera_id => camera_id })
     end
+    
+    # update a camera
+    def update_camera(camera)
+      call_soap_method(:update_camera,'//ns4:UpdateCameraResponse',{ :camera => camera })
+    end
+    
+    # delete the requested camera
+    def delete_camera(camera_id)
+      call_soap_method(:delete_camera,'//ns4:DeleteCameraResponse',{ :camera_id => camera_id})
+    end
 
     # return all of the events
     def get_events
@@ -92,6 +144,11 @@ module GranicusPlatformAPI
       call_soap_method(:get_events_by_foreign_id,'//ns5:GetEventsByForeignIDResponse/events',{ :foreign_id => foreign_id })
     end
     
+    # create an event
+    def create_event(event)
+      call_soap_method(:create_event,'//ns4:CreateEventResponse/EventID',{ :event_data => event })
+    end
+    
     # return the requested event
     def get_event(event_id)
       call_soap_method(:get_event,'//ns5:GetEventResponse/event',{ :event_id => event_id })
@@ -101,6 +158,11 @@ module GranicusPlatformAPI
     def update_event(event)
       call_soap_method(:update_event,'//ns4:UpdateEventResponse',{ :event => event })
     end
+    
+    # delete the requested event
+    def delete_event(event_id)
+      call_soap_method(:delete_event,'//ns4:DeleteEventResponse',{ :event_id => event_id})
+    end
 
     # return all of the event meta data
     def get_event_meta_data(event_id)
@@ -116,6 +178,11 @@ module GranicusPlatformAPI
     def get_clip_meta_data(clip_id)
       call_soap_method(:get_clip_meta_data,'//ns5:GetClipMetaDataResponse/metadata',{ :clip_id => clip_id })
     end
+    
+    # get meta data by id
+    def get_meta_data(meta_id)
+      call_soap_method(:get_meta_data,'//ns5:GetMetaDataResponse/MetaData', { :meta_data_id => meta_id })
+    end
 
     # return all of the folders
     def get_folders
@@ -178,7 +245,7 @@ module GranicusPlatformAPI
       attributes = {}
       hash.each do |key,value|
         case value.class.to_s
-        when 'Hashie::Mash', /GranicusPlatformAPI::/, 'Hash'
+        when /GranicusPlatformAPI::/, 'Hash'
           hash[key] = prepare_request value
         when 'Array'
           hash[key] = prepare_array value
@@ -191,7 +258,7 @@ module GranicusPlatformAPI
     def prepare_array(array)
       array.each_index do |index|
         case array[index].class.to_s
-        when 'Hashie::Mash', /GranicusPlatformAPI::/, 'Hash'
+        when /GranicusPlatformAPI::/, 'Hash'
           array[index] = prepare_request array[index]
         end
       end
@@ -200,8 +267,6 @@ module GranicusPlatformAPI
     
     def attribute_of(value) 
       case value.class.to_s
-      when 'Hashie::Mash','Hash'
-        nil
       when 'Array'
         xsd_type = self.class.classmap[value[0].class.to_s.split('::').last]
         if xsd_type.nil? 
@@ -244,14 +309,13 @@ module GranicusPlatformAPI
           node.to_s
         end
       else
-        # we have a custom type, make it hashie since we don't want true static typing
+        # we have a custom type, attempt to generate it. if that fails use a hash
         proc = self.class.typegenerators[type]
         value = {}
         unless proc.nil?
           value = proc.call
         else
           puts "Unknown custom type: #{type}"
-          value = ::Hashie::Mash.new
         end
         node.children.each do |value_node|
           value[value_node.name] = handle_response value_node

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

@@ -1,6 +1,11 @@
 require 'hashie'
 
 module GranicusPlatformAPI
+  class AgendaItem < Hashie::Dash
+    property :Department
+    property :Actions
+  end
+  
   class Attendee < Hashie::Dash
     property :ID
     property :Name
@@ -9,17 +14,63 @@ module GranicusPlatformAPI
     property :Chair
   end
   
+  class AttendeeStatus < Hashie::Dash
+    property :Name
+    property :Status
+  end
+  
   class CameraData < Hashie::Dash
     property :ID
     property :Type
     property :Name
     property :InternalIP
-    proprety :ExternalIP
+    property :ExternalIP
     property :BroadcastPort
     property :ControlPort
     property :Identifier
   end
   
+  class CaptionData < Hashie::Dash
+    property :Caption
+    property :TimeStamp
+  end
+  
+  class ClipData < Hashie::Dash
+    property :ID
+    property :UID
+    property :ForeignID
+    property :Type
+    property :Name
+    property :Description
+    property :Keywords
+    property :Date
+    property :CameraID
+    property :FolderID
+    property :FileName
+    property :MinutesType
+    property :MinutesFile
+    property :AgendaType
+    property :AgendaFile
+    property :Duration
+    property :Status
+    property :StartTime
+    property :LastModified
+    property :Attendees
+    property :MotionTypes
+    property :Street1
+    property :Street2
+    property :City
+    property :State
+    property :Zip
+    property :AgendaTitle
+    property :AgendaPostedDate
+  end
+  
+  class Document < Hashie::Dash
+    property :Description
+    property :Location
+  end
+  
   class EventData < Hashie::Dash
     property :ID
     property :UID
@@ -59,4 +110,99 @@ module GranicusPlatformAPI
     property :Views
     property :Servers
   end
+
+  class GroupData < Hashie::Dash
+    property :ID
+    property :Name
+    property :Description
+    property :CreatedDate
+  end
+  
+  class KeyMapping < Hashie::Dash
+    property :ForeignID
+    property :GranicusID
+  end
+  
+  class MetaDataData < Hashie::Dash
+    property :ID
+    property :UID
+    property :ParentID
+    property :ParentUID
+    property :ForeignID
+    property :SourceID
+    property :Name
+    property :TimeStamp
+    property :OrderID
+    property :Payload
+    property :Children
+  end
+  
+  class Motion < Hashie::Dash
+    property :Mover
+    property :Seconder
+    property :Type
+    property :MotionText
+  end
+  
+  class Note < Hashie::Dash
+    property :NoteText
+    property :EditorsNotes
+    property :Private
+  end
+  
+  class Rollcall < Hashie::Dash
+    property :Attendees
+  end
+  
+  class ServerData < Hashie::Dash
+    property :ID
+    property :Name
+    property :ControlPort
+    property :FirewallCompatibility
+    property :Multicast
+    property :LoadBalancerScore
+    property :ReplicationUN
+    property :ReplicationPW
+    property :CreatedDate
+  end
+  
+  class ServerInterfaceData < Hashie::Dash
+    property :ID
+    property :ServerID
+    property :Name
+    property :Host
+    property :ControlPort
+    property :Directory
+    property :ReplicationUN
+    property :ReplicationPW
+  end
+  
+  class TemplateData < Hashie::Dash
+    property :ID
+    property :Name
+    property :Description
+    property :Type
+    property :LastModified
+    property :CreatedDate
+  end
+  
+  class ViewData < Hashie::Dash
+    property :ID
+    property :ForeignID
+    property :Name
+    property :IsActive
+    property :Events
+    property :Folders
+  end
+  
+  class VoteEntry < Hashie::Dash
+    property :Name
+    property :Vote
+  end
+  
+  class VoteRecord < Hashie::Dash
+    property :MotionID
+    property :Passed
+    property :Votes
+  end
 end

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

@@ -1,3 +1,3 @@
 module GranicusPlatformAPI
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/granicus-platform-api_spec.rb

@@ -19,53 +19,54 @@ SERVER_ID = 2
 client = GranicusPlatformAPI::Client.new GRANICUS_SITE, GRANICUS_LOGIN, GRANICUS_PASSWORD, {:proxy => 'http://localhost:8888'}
 
 # The projects method
-describe GranicusPlatformAPI, "::Client.login" do
+describe GranicusPlatformAPI, "::Client.new" do
   it "should log me in" do
     logon = client.get_current_user_logon
     logon.should == GRANICUS_LOGIN
   end
 end
 
-describe GranicusPlatformAPI, "::Client.get_cameras" do
+describe GranicusPlatformAPI, "::Client Camera Methods" do
   it "should get my cameras" do
     cameras = client.get_cameras
     found = cameras.find {|c| c.ID == CAMERA_ID } 
     found.should_not == nil
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_camera" do
-  it "should get the requested camera" do
+  it "should create, retreive, update and delete a camera" do
     camera = client.get_camera CAMERA_ID
-    camera.ID.should == CAMERA_ID
+    new_camera_id = client.create_camera camera
+    camera2 = client.get_camera new_camera_id
+    camera2.Name = 'test my new camera'
+    client.update_camera camera2
+    camera3 = client.get_camera new_camera_id
+    camera3.Name.should == 'test my new camera'
+    client.delete_camera new_camera_id
   end
 end
 
-describe GranicusPlatformAPI, "::Client.get_events" do
-  it "should get my events" do
-    events = client.get_events
-    found = events.find {|e| e.ID == EVENT_ID } 
-    found.should_not == nil
+describe GranicusPlatformAPI, "::Client Event Methods" do
+  it "should get all events" do
+     events = client.get_events
+     found = events.find {|e| e.ID == EVENT_ID } 
+     found.should_not == nil
+  end
+  it "should get the requested event" do
+    event = client.get_event EVENT_ID
+    event.UID = ''
+    new_event_id = client.create_event event
+    event2 = client.get_event new_event_id
+    event2.Name = 'test my new event'
+    client.update_event event2
+    event3 = client.get_event new_event_id
+    event3.Name.should == 'test my new event'
+    client.delete_event new_event_id
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_events_by_foreign_id" do
   it "should get all events with matching foreign id" do
     events = client.get_events_by_foreign_id EVENT_FOREIGN_ID
     events.each do |event|
       event.ForeignID.should == EVENT_FOREIGN_ID
     end
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_event" do
-  it "should get the requested event" do
-    event = client.get_event EVENT_ID
-    event.ID.should == EVENT_ID
-  end
-end
-
-describe GranicusPlatformAPI, "::Client.update_event" do
   it "should update a simple property on requested event" do
     event = client.get_event UPDATE_EVENT_ID
     event.ID.should == UPDATE_EVENT_ID
@@ -86,85 +87,72 @@ describe GranicusPlatformAPI, "::Client.update_event" do
     event.Attendees[0].Name = 'my test'
     client.update_event event
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_event_by_uid" do
-  it "should get the requested event" do
+  
+  it "should get the requested event by UID" do
     event = client.get_event_by_uid EVENT_UID
     event.UID.should == EVENT_UID
   end
-end
-
-describe GranicusPlatformAPI, "::Client.set_event_agenda_url" do
-  it "not return an error" do
+  
+  it "set the event agenda url" do
     event = client.set_event_agenda_url EVENT_ID, "http://github.com/gov20cto/granicus-platform-api"
   end
 end
 
-describe GranicusPlatformAPI, "::Client.get_folders" do
+describe GranicusPlatformAPI, "::Client Folder Methods" do
   it "should get my folders" do
     folders = client.get_folders
     folders[0].ID.should == FOLDER_ID
   end
 end
 
-describe GranicusPlatformAPI, "::Client.get_clips" do
+describe GranicusPlatformAPI, "::Client Clip Methods" do
   it "should get clips from the given folder" do
     clips = client.get_clips FOLDER_ID
     clips.each do |clip|
       clip.FolderID.should == FOLDER_ID
     end
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_clips_by_foreign_id" do
   it "should get all clips with matching foreign id" do
     clips = client.get_clips_by_foreign_id CLIP_FOREIGN_ID
     clips.each do |clip|
       clip.ForeignID.should == CLIP_FOREIGN_ID
     end
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_clip" do
   it "should get the requested clip" do
     clip = client.get_clip CLIP_ID
     clip.ID.should == CLIP_ID
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_clip_by_uid" do
-  it "should get the requested clip" do
+  it "should get the requested clip by UID" do
     clip = client.get_clip_by_uid CLIP_UID
     clip.ID.should == CLIP_UID
   end
 end
 
-describe GranicusPlatformAPI, "::Client.get_event_meta_data" do
-  it "should get my event meta data" do
+describe GranicusPlatformAPI, "::Client MetaData Methods" do
+  it "should get an event's meta data" do
     metadata = client.get_event_meta_data EVENT_ID
     found = metadata.find {|m| m.ID == EVENT_META_ID } 
     found.should_not == nil
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_clip_meta_data" do
-  it "should get my clip meta data" do
+  it "should get a clip's meta data" do
     metadata = client.get_clip_meta_data CLIP_ID
     found = metadata.find {|m| m.ID == CLIP_META_ID } 
     found.should_not == nil
   end
+  
+  it "should get the requested meta data" do
+    metadata = client.get_meta_data CLIP_META_ID
+    metadata.ID = CLIP_META_ID
+    puts metadata
+  end
 end
 
-describe GranicusPlatformAPI, "::Client.get_servers" do
+describe GranicusPlatformAPI, "::Client Server Methods" do
   it "should get all servers" do
     servers = client.get_servers
     found = servers.find {|s| s.ID == SERVER_ID } 
     found.should_not == nil
   end
-end
-
-describe GranicusPlatformAPI, "::Client.get_server" do
   it "should get the requested server" do
     server = client.get_server SERVER_ID
     server.ID.should == SERVER_D

data/spec/helper.rb

@@ -1,3 +1,7 @@
+# enable SimpleCov
+require 'simplecov'
+SimpleCov.start
+
 require 'rubygems'
 require 'bundler/setup'
 require 'granicus-platform-api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: granicus-platform-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-27 00:00:00.000000000Z
+date: 2011-06-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152688320 !ruby/object:Gem::Requirement
+  requirement: &2164634720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,43 +21,43 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2152688320
+  version_requirements: *2164634720
 - !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: &2152687820 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &2164634220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *2152687820
+  version_requirements: *2164634220
 - !ruby/object:Gem::Dependency
-  name: savon
-  requirement: &2156842740 !ruby/object:Gem::Requirement
+  name: hashie
+  requirement: &2164633760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156842740
+  version_requirements: *2164633760
 - !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: &2156842280 !ruby/object:Gem::Requirement
+  name: savon
+  requirement: &2164633300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2156842280
+  version_requirements: *2164633300
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &2156841820 !ruby/object:Gem::Requirement
+  requirement: &2164632840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156841820
+  version_requirements: *2164632840
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2156841360 !ruby/object:Gem::Requirement
+  requirement: &2164632380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,18 +76,7 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156841360
-- !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: &2156840900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: *2156840900
+  version_requirements: *2164632380
 description: Wrapper for the Granicus Open Platform API v1.x
 email: javier@granicus.com
 executables: []