icws 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51ae20e8401fa11a039502013feec4fa9ac3bc72
-  data.tar.gz: c47b130b74d603c37d99e970eee2a8ff1f325d73
+  metadata.gz: 575b2aa69177c2632359c9d1b0298b16c49e1b71
+  data.tar.gz: 3c6e99cb472ffd41cd54057173a30b8e6f2381ab
 SHA512:
-  metadata.gz: 1e6bda8d7475b21d65995dd848dabefa78d188301e7a57c7567434f3df3f7a50063f2a9ce0909088702cb2dd859d1deb51bc2b5ed825e65650824bba09287da2
-  data.tar.gz: 92d1fe0ffc491192cafa27698db0b962110107c9807c488aa81d4e157d80f871735628b5b030f933de7a1fc8e2a632351a10a04d75eee8b6c54f7fa448cff97e
+  metadata.gz: e47e6b5e566d612c802c8f90d2096c9afcc4ce09133b6e910912b345be5210023a63fcc73d9d5cbd8a3fa3568e741cd8114d1b59711c904d6b546f302d72256a
+  data.tar.gz: 9aa45ee9a97ea8399fc5c1fb9c1f4d2c550f7e5515a068f282090869e6f7c9e98952b9e751f55a7aa83cc17e7aa57b2c347a81efb6c2be98802cd5274b4481e7

data/CHANGELOG.md

@@ -0,0 +1 @@
+### Next Release

data/RAKEFILE

@@ -1,12 +1,15 @@
 require 'rake/testtask'
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new do |t|
   t.libs << "test"
     t.test_files = FileList.new('test/**/*.rb')
-    #t.test_files = FileList.new('test/configuration/roles.rb')
-    #t.test_files = FileList.new('test/test_connection.rb')
+#    t.test_files = FileList.new('test/*.rb')
     t.verbose = true
 end
 
 desc "Run tests"
-task :default => :test
+task :default => :test

data/README.md

@@ -0,0 +1,50 @@
+[![Gem Version](https://badge.fury.io/rb/icws.svg)](http://badge.fury.io/rb/icws)
+
+A gem that wraps up the ICWS ReST api
+
+Examples
+==============
+
+Making a Connection
+
+``` ruby
+    connection = ICWS::Connection.new APPLICATIONNAME, SERVER
+    connection.connect USERID, PASSWORD
+```
+
+Deleting a user:
+``` ruby
+    def delete_user(id, connection)
+        user_config = ICWS::Configuration::Users.new connection
+        user_config.delete URI.escape id
+    end
+```
+
+Create a Workgroup:
+
+``` ruby
+  def setup_workgroup(workgroup_name, extension, connection)
+    workgroup_config = ICWS::Configuration::Workgroups.new connection
+    workgroups = workgroup_config.get_all.select {|r| r['configurationId']['id'] == workgroup_name}
+
+    workgroupId = workgroup_name
+
+    if(workgroups.length ==0)
+      new_workgroup = {
+        :queueType => 5,
+        :hasQueue => true,
+        :isActive => true,
+        :extension => extension
+      }
+
+      workgroup_config.create_new workgroupId, new_workgroup
+    end
+  end
+```
+
+Set a User's Status
+
+``` ruby
+    status = ICWS::Status.new connection
+    status.set_user_status URI.escape(id), 'AVAILABLE'
+```

data/RELEASING.md

@@ -0,0 +1,33 @@
+# Releasing ICWS
+
+There're no particular rules about when to release ICWS. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake test
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/tim-vandecasteele/grape-swagger) for all supported platforms.
+
+Increment the version, modify [icws.gemspec](icws.gemspec).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.7.1` to `0.7.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.7.1` to `0.8.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.7.2 (February 6, 2014)
+```
+
+Commit your changes.
+
+Release.
+
+```
+$ rake release
+```

data/lib/icws/connection.rb

@@ -19,69 +19,71 @@ class ICWS
         # @param password [String] the password for the user
         def connect(user, password)
             connectResponse = RestClient.post @server +'/icws/connection',
-            { :applicationName => @application_name,
+            {
+                '__type' => "urn:inin.com:connection:icAuthConnectionRequestSettings",
+                :applicationName => @application_name,
                 :userID => user,
-                :password => password}.to_json,
-                :content_type => :json,
-                :accept => :json,
-                'Accept-Language' => 'en-us'
+                :password => password
+            }.to_json,
+            :content_type => :json,
+            :accept => :json,
+            'Accept-Language' => 'en-us'
 
-                response = JSON.parse(connectResponse);
-                @cookie = connectResponse.headers[:set_cookie][0]
-                @csrf_token = response['csrfToken']
-                @session_id = response['sessionId']
+            response = JSON.parse(connectResponse);
+            @cookie = connectResponse.headers[:set_cookie][0]
+            @csrf_token = response['csrfToken']
+            @session_id = response['sessionId']
 
-            end
+        end
 
-            # Gets the name of the application.
-            # @return [String] Application name.
-            def application_name
-                @application_name
-            end
+        # Gets the name of the application.
+        # @return [String] Application name.
+        def application_name
+            @application_name
+        end
 
-            # Gets the connection token.
-            # @return [String] connection token
-            def token
-                @csrf_token
-            end
+        # Gets the connection token.
+        # @return [String] connection token
+        def token
+            @csrf_token
+        end
 
-            # Gets the connection cookie.
-            # @return [String] connection cookie
-            def cookie
-                @cookie
-            end
+        # Gets the connection cookie.
+        # @return [String] connection cookie
+        def cookie
+            @cookie
+        end
 
-            # Gets the url of the server
-            # @return [String] the url of the server
-            def server
-                @server
-            end
+        # Gets the url of the server
+        # @return [String] the url of the server
+        def server
+            @server
+        end
 
-            # Gets the version of the server.
-            # @return the version of the server.
-            def version
-                JSON.parse RestClient.get @server+'/icws/connection/version'
-            end
+        # Gets the version of the server.
+        # @return the version of the server.
+        def version
+            JSON.parse RestClient.get @server+'/icws/connection/version'
+        end
 
-            # Gets the features of the server.
-            # @return [Array[ICWS::Connection::Features]] the features of the server
-            def features
-                data = JSON.parse RestClient.get @server+'/icws/connection/features'
-                features = data["featureInfoList"].map { |rd| ICWS::Connection::Feature.new(rd["featureId"], rd["version"]) }
-            end
+        # Gets the features of the server.
+        # @return [Array[ICWS::Connection::Features]] the features of the server
+        def features
+            data = JSON.parse RestClient.get @server+'/icws/connection/features'
+            features = data["featureInfoList"].map { |rd| ICWS::Connection::Feature.new(rd["featureId"], rd["version"]) }
+        end
 
-            # Generates a full uri given the resource path.
-            # @param path [String] The path to the ReST resource.
-            # @return [String] The full url.
-            def generate_uri(path)
-                base_uri + path
-            end
+        # Generates a full uri given the resource path.
+        # @param path [String] The path to the ReST resource.
+        # @return [String] The full url.
+        def generate_uri(path)
+            base_uri + path
+        end
 
-            # Returns the base uri to the server, including the session id
-            # @return [String] The base url with session id.
-            def base_uri
-                @server+'/icws/' + @session_id +'/'
-            end
+        # Returns the base uri to the server, including the session id
+        # @return [String] The base url with session id.
+        def base_uri
+            @server+'/icws/' + @session_id 
         end
     end
 end

data/lib/icws/status/status.rb

@@ -13,7 +13,7 @@ class ICWS
         def all_system_statuses
             status_list = @client.get '/status/status-messages'
             statuses = []
-            status_list['statusMessageList'].each {|s| statuses.push ICWS::StatusMessage.new(s)}
+            status_list['statusMessageList'].each {|s| statuses.push ICWS::Status::StatusMessage.new(s)}
             return statuses
         end
 

data/lib/icws/status/statusmessage.rb

@@ -1,41 +1,41 @@
 class ICWS
-  class StatusMessage
-    attr_reader :status_id
-    attr_reader :message_text
-    attr_reader :icon_uri
-    attr_reader :group_tag
-    attr_reader :can_have_date
-    attr_reader :can_have_time
-    attr_reader :is_do_not_disturb_status
-    attr_reader :is_selectable_status
-    attr_reader :is_persistent_status
-    attr_reader :is_forward_status
-    attr_reader :is_after_call_work_status
-    attr_reader :is_acd_status
-    attr_reader :is_allow_follow_up_status
-    attr_reader :system_id
-    
-    def initialize(property_map)
-      @status_id = property_map['statusId']
-      @message_text = property_map['messageText']
-      @icon_uri = property_map['iconUri']
-      @group_tag = property_map['groupTag']
-      @can_have_date = property_map['canHaveDate']
-      @can_have_time = property_map['canHaveTime']
-      @is_do_not_disturb_status = property_map['isDoNotDisturbStatus']
-      @is_selectable_status = property_map['isSelectableStatus']
-      @is_fersistent_status = property_map['isPersistentStatus']
-      @is_forward_status = property_map['isForwardStatus']
-      @is_after_call_work_status = property_map['isAfterCallWorkStatus']
-      @is_acd_status = property_map['isAcdStatus']
-      @is_allow_follow_up_status = property_map['isAllowFollowUpStatus']
-      @system_id   = property_map['systemId']
-    end
-    
-    def to_s
-      status_id + ', ' + message_text + ',' + icon_uri 
-    end
-  end
-end
+    class Status
+        class StatusMessage
+            attr_reader :status_id
+            attr_reader :message_text
+            attr_reader :icon_uri
+            attr_reader :group_tag
+            attr_reader :can_have_date
+            attr_reader :can_have_time
+            attr_reader :is_do_not_disturb_status
+            attr_reader :is_selectable_status
+            attr_reader :is_persistent_status
+            attr_reader :is_forward_status
+            attr_reader :is_after_call_work_status
+            attr_reader :is_acd_status
+            attr_reader :is_allow_follow_up_status
+            attr_reader :system_id
 
+            def initialize(property_map)
+                @status_id = property_map['statusId']
+                @message_text = property_map['messageText']
+                @icon_uri = property_map['iconUri']
+                @group_tag = property_map['groupTag']
+                @can_have_date = property_map['canHaveDate']
+                @can_have_time = property_map['canHaveTime']
+                @is_do_not_disturb_status = property_map['isDoNotDisturbStatus']
+                @is_selectable_status = property_map['isSelectableStatus']
+                @is_fersistent_status = property_map['isPersistentStatus']
+                @is_forward_status = property_map['isForwardStatus']
+                @is_after_call_work_status = property_map['isAfterCallWorkStatus']
+                @is_acd_status = property_map['isAcdStatus']
+                @is_allow_follow_up_status = property_map['isAllowFollowUpStatus']
+                @system_id   = property_map['systemId']
+            end
 
+            def to_s
+                status_id + ', ' + message_text + ',' + icon_uri
+            end
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icws
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Glinski
@@ -44,8 +44,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - RAKEFILE
+- README.md
+- RELEASING.md
 - lib/icws/configuration/configurationitem.rb
 - lib/icws/configuration/roles.rb
 - lib/icws/configuration/stations.rb