vws 1.2.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40511c3687d64aad2e56ad82ff056af559a59284
-  data.tar.gz: bb459c1ccb87491297b8cb913e5d6371527b4ceb
+  metadata.gz: a8e8f520b6858b811e7364870611efde7b48e9a2
+  data.tar.gz: 7cb620d7706e9fcd71457d2cda8d5837f8d26b7d
 SHA512:
-  metadata.gz: 1be173437a87bd840936aa81131febdd10b095cda78cd45c8095c0058c50b7fc36b76f231baf6109426ec0ad14192d18eb0087ccf1687efc2768722c3eada774
-  data.tar.gz: 000b3675378731035b85351b6cf55f62195d64d916301e335bb690fa15ac9221b38ddad3652f8213dbe8b632df2681085c1c740c42dec95be23e8445f5277724
+  metadata.gz: f683f9a33a6f0afbd5c86b0898cb908076bed286a70addc77890ffa9a60d59f8bae121381e8f5450dd95f3deab68350e1e66f13756758dea34ffa40fd51ee706
+  data.tar.gz: 02ef649bca4db7f834021685ddf6fac5f232fa4feeca83de755c03c5ae100aeb7a36e8501fe2992a01cfdf15338601b5831d600e94deb52350a600c63e0b865f

data/.gitignore

@@ -1,18 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-spec/local_env.yml
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/local_env.yml

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in vws.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vws.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Nikos Kokkos
-
-MIT License
-
-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.
-
-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.
+Copyright (c) 2013 Nikos Kokkos
+
+MIT License
+
+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.
+
+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.

data/README.md

@@ -1,140 +1,153 @@
-# Vws (Vuforia Web Services ruby gem for API access for target management)
-
-This is a ruby gem to interact with Vuforia web services api for managing the targets:
-https://developer.vuforia.com/resources/dev-guide/managing-targets-cloud-database-using-developer-api
-
-It uses the excellent rest-client (https://github.com/rest-client/rest-client) to handle the
-HTTP/REST requests required by the Vuforia Web Services API.
-
-## Installation from source:
-
-
-Clone this repo onto your hard drive and cd into the root folder.
-
-
-First install bundler gem (if it is not installed) by issuing:
-
-    gem install bundler
-
-Install the required gems by vws gem by:
-
-    bundle install
-
-Build the vws gem by:
-
-    rake build
-
-This will build the vws.gem into the pkg folder.
-
-
-Install the gem from the pkg folder by:
-
-    gem install vws.gem
-
-
-## Basic Installation using rails Gemfile: 
-
-
-Add this line to your rails application's Gemfile:
-
-    gem 'vws'
-
-And then execute:
-
-    bundle install
-
-
-The gem has been uploaded to rubygems.org (http://rubygems.org/gems/vws), therefore you can simply issue:
-
-    gem install vws 
-    
-and you'll be set.
-
-
-## Usage:
-
-Instantiate a connection to the api with:
-
-    connection = Vws::Api.new("your_server_vws_access_key", "your_server_vws_secret_key")
-
-After a successful connection, you should have access to the vuforia api as shown here:
-https://developer.vuforia.com/library//articles/Solution/How-To-Use-the-Vuforia-Web-Services-API
-
-So, if you want to get a summary of the cloud database, you issue:
-
-    connection.summary
-
-For a list of targets in your database:
-
-     connection.list_targets
-
-To retrieve a target's info:
-     
-     connection.retrieve_target(target_id)
-
-To activate or deactivate a target:
-    
-     connection.set_active_flag(target_id, active_flag) where active_flag = true/false
-
-To add a target to the database:
-
-    connection.add_target(target_name, file_path, width, active_flag, application_metadata)
-You may set application_metadata = nil if you do not use this attribute
-
-To delete a target:
-    
-    connection.delete_target(target_id)
-
-but before deleting a target, you have to set to inactive if it active and
-wait for a while:
-
-Change a target flag to inactive/active:
-    
-    connection.set_active_flag(target_id, active_flag), where active_flag=true/false
-
-List duplicates for target:
-
-    connection.list_duplicates(target_id)
-
-## Attributes of the uploaded file:
-Vuforia has a great article about what makes a target ideal:
-https://developer.vuforia.com/library/articles/Best_Practices/Attributes-of-an-Ideal-Image-Target
-Currently, this ruby gem does not check for file size or any other attributes addressed in the article above.
-
-
-## Spec
-
-Enter your server keys into vws_spec.rb file and run the specs at the root 
-of the folder by issuing:
-
-    rspec spec
-
-
-##Caveats
-
-Setting a target from on to off and vice versa takes some time. It may take up to
-0-10 minutes and it's based on Vuforia's infrastucture. It is your responsibilty 
-to poll for the changes on the target since no such feature has been implemented
-in this gem.
-
-
-
-## To do:
-
-  Implement some of the new vws apis
-
-## Contributing
-
-Please, if you use it, report back any bugs/problems.
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-This software is licensed under the MIT License (MIT).
-
-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.
+# Vws (Vuforia Web Services ruby gem for API access for target management)
+
+This is a ruby gem to interact with Vuforia web services api for managing the targets:
+https://developer.vuforia.com/library//articles/Solution/How-To-Use-the-Vuforia-Web-Services-API
+
+It uses the excellent rest-client (https://github.com/rest-client/rest-client) to handle the
+HTTP/REST requests required by the Vuforia Web Services API.
+
+## Installation from source:
+
+Clone this repo onto your hard drive and cd into the root folder.
+
+First install bundler gem (if it is not installed) by issuing:
+
+    gem install bundler
+
+Install the required gems by vws gem by:
+
+    bundle install
+
+Build the vws gem by:
+
+    rake build
+
+This will build the vws.gem into the pkg folder.
+
+Install the gem from the pkg folder by:
+
+    gem install vws.gem
+
+
+## Basic Installation using rails Gemfile: 
+
+
+Add this line to your rails application's Gemfile:
+
+    gem 'vws'
+
+And then execute:
+
+    bundle install
+
+
+The gem has been uploaded to rubygems.org (http://rubygems.org/gems/vws), therefore you can simply issue:
+
+    gem install vws 
+    
+and you'll be set.
+
+
+## Usage:
+
+Instantiate a connection to the api with:
+
+    connection = Vws::Api.new("your_server_vws_access_key", "your_server_vws_secret_key")
+
+After a successful connection, you should have access to the vuforia api as shown here:
+https://developer.vuforia.com/library/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API
+
+So, if you want to get a summary of the cloud database, you issue:
+
+    connection.summary
+
+For a list of targets in your database:
+
+     connection.list_targets
+
+To retrieve a target's info:
+     
+     connection.retrieve_target(target_id)
+
+To activate or deactivate a target:
+    
+     connection.set_active_flag(target_id, active_flag) where active_flag = true/false
+
+To add a target to the database:
+
+    connection.add_target(target_name, file_path, width, active_flag, application_metadata)
+You may set application_metadata = nil if you do not use this attribute
+
+To delete a target:
+    
+    connection.delete_target(target_id)
+
+but before deleting a target, you have to set to inactive if it active and
+wait for a while:
+
+Change a target flag to inactive/active:
+    
+    connection.set_active_flag(target_id, active_flag), where active_flag=true/false
+
+List duplicates for target:
+
+    connection.list_duplicates(target_id)
+    
+
+## Parsing the output:
+
+Response from the server is in JSON(text/string) format. So, you can easily parse the output and convert it to a Hash with keys. For example you may parse the output as such:
+
+    connection_hash = JSON.parse(connection)
+    
+Once you do that, you have access to the list of the hash's keys with
+    
+    connection_hash.keys
+    
+Then, you can grab the information relating to a certain key with:
+
+    connection_hash["key"]
+
+For example, here you can find the keys from the response after asking for the database summary:
+https://developer.vuforia.com/library/articles/Solution/How-To-Get-a-Database-Summary-Report-Using-the-VWS-API. 
+From that you can extract the name of the database with:
+
+    connection_hash["name"]
+
+
+## Attributes of the uploaded file:
+Vuforia has a great article about what makes a target ideal:
+https://developer.vuforia.com/library/articles/Best_Practices/Attributes-of-an-Ideal-Image-Target
+Currently, this ruby gem does not check for file size or any other attributes addressed in the article above.
+
+
+## Spec
+
+Enter your server keys into vws_spec.rb file and run the specs at the root 
+of the folder by issuing:
+
+    rspec spec
+
+
+##Caveats
+
+Setting a target from on to off and vice versa takes some time. It may take up to
+0-10 minutes and it's based on Vuforia's infrastucture. It is your responsibilty 
+to poll for the changes on the target since no such feature has been implemented
+in this gem. More you can find here: https://developer.vuforia.com/library//articles/Best_Practices/Best-Practices-for-using-the-VWS-API
+
+## Contributing
+
+Please, if you use it, report back any bugs/problems.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This software is licensed under the MIT License (MIT).
+
+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.

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+

data/lib/vws.rb

@@ -1,257 +1,258 @@
-require "vws/version"
-require 'rubygems'
-require 'rest_client'
-require 'digest/md5'
-require 'time'
-require 'openssl'
-require 'base64'
-require 'json'
-
-
-module Vws
-  #constants for end point interface links
-   BASE_URL = "https://vws.vuforia.com"
-   TARGETS_URL = BASE_URL + "/targets"
-   SUMMARY_URL = BASE_URL + "/summary"
-   DUPLICATES_URL = BASE_URL + "/duplicates"
-
-  class Api
-  
-    def initialize(accesskey=nil, secretkey=nil)
-      @accesskey = accesskey || ENV['VWS_ACCESSKEY']
-      @secretkey = secretkey || ENV['VWS_SECRETKEY']
-    end
-
-    def build_signature(request_path, body_hash, http_verb, timestamp)
-      # request_path signifies the suburi you call after you subtract the 
-      # BASE_URL; that is, if you call https://vws/vuforia.com/targets, 
-      # the request_path is '/targets' 
-      
-      contentType = ""
-      hexDigest = "d41d8cd98f00b204e9800998ecf8427e" # Hex digest of an empty 
-                                                     # string. We use it to 
-                                                     # signify empty body
-
-      if http_verb == "GET" || http_verb == "DELETE" 
-        # Do nothing since we have already set contentType and hexDigest
-      elsif http_verb == "POST" || http_verb == "PUT" 
-        contentType = "application/json";
-        # the request should have a request body, so create an md5 hash of that
-        # json body data
-        hexDigest = Digest::MD5.hexdigest(body_hash.to_json)
-      else 
-        puts "Invalid request method for signature method: " + http_verb
-        return nil
-      end
-      
-      toDigest  = http_verb   + "\n" +
-                  hexDigest   + "\n" +
-                  contentType + "\n" +
-                  timestamp   + "\n" +
-                  request_path
-
-      return Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, 
-                              @secretkey, toDigest))  
-    end
-
-    # Calls the api end point for the list of targets associated with 
-    # server access key and cloud database
-    # https://developer.vuforia.com/library/articles/Solution/How-To-Get-a-Target-List-for-a-Cloud-Database-Using-the-VWS-API
-    def list_targets
-      #Date is the current date per RFC 2616, section 3.3.1, 
-      #rfc1123-date format, e.g.: Sun, 22 Apr #2012 08:49:37 GMT.
-      date_timestamp = Time.now.httpdate #ruby provides this date format 
-                                         #with httpdate method
-      signature = self.build_signature('/targets', nil, 'GET', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      
-      authorization_header = "VWS " + @accesskey + ":" +  signature
-      begin
-        RestClient.get(TARGETS_URL, :'Date' => date_timestamp, 
-                                    :'Authorization' => authorization_header)
-      rescue => e
-        e.response
-      end
-    end
-
-    def add_target(target_name, file_path, width, active_flag, application_metadata=nil)
-      raise "file path is required"   if file_path.nil?
-      raise "target name is required" if target_name.nil?
-      date_timestamp = Time.now.httpdate 
-      #for file uploads, read file contents data and Base 64 encode it:
-      contents_encoded = Base64.encode64(File.open(file_path, 'rb').read)
-      body_hash = { :name => target_name, 
-                    :width => width, #width of the target in scene units
-                    :image => contents_encoded, 
-                    :active_flag => active_flag }
-      signature = self.build_signature('/targets', body_hash, 'POST', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" +  signature
-      begin
-        RestClient.post(TARGETS_URL, body_hash.to_json, 
-                                    :'Date' => date_timestamp, 
-                                    :'Authorization' => authorization_header, 
-                                    :content_type => 'application/json', 
-                                    :accept => :json)
-      rescue => e
-        e.response
-      end
-    end
-    
-    # Updates an existing target. Target_id must already exist
-    # https://developer.vuforia.com/library/articles/Solution/How-To-Update-a-Target-Using-the-VWS-API
-    def update_target(target_id, target_name=nil, file_path=nil, width=nil, active_flag=nil)
-      raise "target id should be be nil" if target_id == nil
-      date_timestamp = Time.now.httpdate
-      target_id_url = TARGETS_URL + '/' + target_id
-      target_id_suburl = '/targets' + '/' + target_id  
-      #for file uploads, read file contents data and Base 64 encode it:
-      contents_encoded = Base64.encode64(File.open(file_path, 'rb').read)
-      body_hash = { :name => target_name, 
-                    :width => width, #Width of the target in scene unit
-                    :image => contents_encoded, 
-                    :active_flag => active_flag }
-      signature = self.build_signature(target_id_suburl, body_hash, 'PUT', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" +  signature
-      begin
-        RestClient.put(target_id_url, body_hash.to_json, 
-                                    :'Date' => date_timestamp, 
-                                    :'Authorization' => authorization_header, 
-                                    :content_type => 'application/json', 
-                                    :accept => :json)
-      rescue => e
-        e.response
-      end
-    end
-    
-    # Database Summary Report
-    # https://developer.vuforia.com/resources/dev-guide/database-summary-report
-    def summary
-      date_timestamp = Time.now.httpdate
-      signature = self.build_signature('/summary', nil, 'GET', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" + signature
-      begin
-        RestClient.get(SUMMARY_URL, :'Date' => date_timestamp, 
-                                    :'Authorization' => authorization_header)
-      rescue => e
-        e.response
-      end
-    end
-    
-    # Retrieve a target from the cloud database
-    # https://developer.vuforia.com/resources/dev-guide/retrieving-target-cloud-database
-    def retrieve_target(target_id)
-      date_timestamp = Time.now.httpdate
-      target_id_url = TARGETS_URL + '/' + target_id
-      target_id_suburl = '/targets' + '/' + target_id
-      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" + signature
-      begin
-        RestClient.get(target_id_url, :'Date' => date_timestamp,
-                                      :'Authorization' => authorization_header)
-      rescue => e
-        e.response
-      end
-    end
-
-    # Target Summary Report
-    # https://developer.vuforia.com/resources/dev-guide/target-summary-report
-    def target_summary(target_id)
-      date_timestamp = Time.now.httpdate
-      target_id_url = SUMMARY_URL + '/' + target_id
-      target_id_suburl = '/summary' + '/' + target_id
-      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
-      authorization_header = "VWS " + @accesskey + ":" + signature
-      begin
-        RestClient.get(target_id_url, :'Date' => date_timestamp,
-                                      :'Authorization' => authorization_header)
-      rescue => e
-        e.response
-      end      
-    end
-
-    def set_active_flag(target_id, active_flag)
-      date_timestamp = Time.now.httpdate
-      target_id_url = TARGETS_URL + '/' + target_id
-      target_id_suburl = '/targets' + '/' + target_id
-      body_hash = {:active_flag => active_flag}
-      signature = self.build_signature(target_id_suburl, body_hash, 'PUT', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" + signature
-      begin
-        RestClient.put(target_id_url, body_hash.to_json, 
-                                      :'Date' => date_timestamp, 
-                                      :'Authorization' => authorization_header, 
-                                      :content_type => 'application/json', 
-                                      :accept => :json)
-      rescue => e
-          e.response
-      end
-    end
-
-    # Delete a target in a cloud database
-    # https://developer.vuforia.com/library/articles/Solution/How-To-Delete-a-Target-Using-the-VWS-API
-    def delete_target(target_id)
-      # In order to delete the target, we have to set it to non-active.
-      # Therefore,first retrieve target info and act accordingly to target info
-      # returned
-      target_data = JSON.parse(retrieve_target(target_id)) # have to JSON.parse
-      # retrieve_target's results since they're in string format
-      target_result_code = target_data["result_code"]
-      if target_result_code != "AuthenticationFailure"
-        if target_result_code != "UnknownTarget"   
-          target_active_flag = target_data["target_record"]["active_flag"]
-          target_status = target_data["status"]
-          if target_result_code == "Success"
-            if target_active_flag == true && target_status == "success"
-              return {:result_code => "TargetActive"}.to_json
-            elsif target_active_flag == false && target_status == "success"
-              # if we reached this point, the target is fine, inactive and 
-              # ready to be deleted
-              date_timestamp = Time.now.httpdate
-              target_id_url = TARGETS_URL + '/' + target_id
-              target_id_suburl = '/targets' + '/' + target_id
-              signature = self.build_signature(target_id_suburl, nil, 'DELETE', date_timestamp)
-              raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-              authorization_header = "VWS " + @accesskey + ":" + signature
-                begin
-                  RestClient.delete(target_id_url, 
-                                             :'Date' => date_timestamp,
-                                             :'Authorization' => authorization_header)
-                rescue => e
-                  e.response
-                end
-            else
-              return {:result_code => "#{target_status}"}.to_json
-            end
-          end  
-        else
-          return {:result_code => "UnknownTarget"}.to_json
-        end
-      else
-        return {:result_code => "AuthenticationFailure"}.to_json
-      end
-    end
-
-    def list_duplicates(target_id)
-      date_timestamp = Time.now.httpdate
-
-      target_id_url = DUPLICATES_URL + '/' + target_id
-      target_id_suburl = '/duplicates' + '/' + target_id
-
-      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
-      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
-      authorization_header = "VWS " + @accesskey + ":" +  signature
-      begin
-        RestClient.get(target_id_url, :'Date' => date_timestamp, 
-                                      :'Authorization' => authorization_header)
-      rescue => e
-        e.response
-      end
-    end
-  
-  end
-end
+require "vws/version"
+require 'rubygems'
+require 'rest_client'
+require 'digest/md5'
+require 'time'
+require 'openssl'
+require 'base64'
+require 'json'
+
+
+module Vws
+  #constants for end point interface links
+   BASE_URL = "https://vws.vuforia.com"
+   TARGETS_URL = BASE_URL + "/targets"
+   SUMMARY_URL = BASE_URL + "/summary"
+   DUPLICATES_URL = BASE_URL + "/duplicates"
+
+  class Api
+
+    def initialize(accesskey=nil, secretkey=nil)
+      @accesskey = accesskey || ENV['VWS_ACCESSKEY']
+      @secretkey = secretkey || ENV['VWS_SECRETKEY']
+    end
+
+    def build_signature(request_path, body_hash, http_verb, timestamp)
+      # request_path signifies the suburi you call after you subtract the
+      # BASE_URL; that is, if you call https://vws/vuforia.com/targets,
+      # the request_path is '/targets'
+
+      contentType = ""
+      hexDigest = "d41d8cd98f00b204e9800998ecf8427e" # Hex digest of an empty
+                                                     # string. We use it to
+                                                     # signify empty body
+
+      if http_verb == "GET" || http_verb == "DELETE"
+        # Do nothing since we have already set contentType and hexDigest
+      elsif http_verb == "POST" || http_verb == "PUT"
+        contentType = "application/json";
+        # the request should have a request body, so create an md5 hash of that
+        # json body data
+        hexDigest = Digest::MD5.hexdigest(body_hash.to_json)
+      else
+        puts "Invalid request method for signature method: " + http_verb
+        return nil
+      end
+
+      toDigest  = http_verb   + "\n" +
+                  hexDigest   + "\n" +
+                  contentType + "\n" +
+                  timestamp   + "\n" +
+                  request_path
+
+      return Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new,
+                              @secretkey, toDigest))
+    end
+
+    # Calls the api end point for the list of targets associated with
+    # server access key and cloud database
+    # https://developer.vuforia.com/library/articles/Solution/How-To-Get-a-Target-List-for-a-Cloud-Database-Using-the-VWS-API
+    def list_targets
+      #Date is the current date per RFC 2616, section 3.3.1,
+      #rfc1123-date format, e.g.: Sun, 22 Apr #2012 08:49:37 GMT.
+      date_timestamp = Time.now.httpdate #ruby provides this date format
+                                         #with httpdate method
+      signature = self.build_signature('/targets', nil, 'GET', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+
+      authorization_header = "VWS " + @accesskey + ":" +  signature
+      begin
+        RestClient.get(TARGETS_URL, :'Date' => date_timestamp,
+                                    :'Authorization' => authorization_header)
+      rescue => e
+        e.response
+      end
+    end
+
+    def add_target(target_name, file_path, width, active_flag, metadata=nil)
+      raise "file path is required"   if file_path.nil?
+      raise "target name is required" if target_name.nil?
+      date_timestamp = Time.now.httpdate
+      #for file uploads, read file contents data and Base 64 encode it:
+      contents_encoded = Base64.encode64(open(file_path) { |io| io.read })
+      metadata_encoded = Base64.encode64(metadata.to_s)
+      body_hash = { :name => target_name, 
+                    :width => width, #width of the target in scene units
+                    :image => contents_encoded, 
+                    :active_flag => active_flag, 
+                    :application_metadata => metadata_encoded }
+      signature = self.build_signature('/targets', body_hash, 'POST', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" +  signature
+      begin
+        RestClient.post(TARGETS_URL, body_hash.to_json,
+                                    :'Date' => date_timestamp,
+                                    :'Authorization' => authorization_header,
+                                    :content_type => 'application/json',
+                                    :accept => :json)
+      rescue => e
+        e.response
+      end
+    end
+
+    def update_target(target_id, target_name=nil, file_path=nil, width=nil, active_flag=nil, metadata=nil)
+      date_timestamp = Time.now.httpdate
+      target_id_url = TARGETS_URL + '/' + target_id
+      target_id_suburl = '/targets' + '/' + target_id
+      #for file uploads, read file contents data and Base 64 encode it:
+      contents_encoded = Base64.encode64(open(file_path) { |io| io.read })
+      metadata_encoded = Base64.encode64(metadata.to_s)
+      body_hash = { :name => target_name, 
+                    :width => width, #Width of the target in scene unit
+                    :image => contents_encoded,
+                    :active_flag => active_flag,
+                    :application_metadata => metadata_encoded }
+      signature = self.build_signature(target_id_suburl, body_hash, 'PUT', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" +  signature
+      begin
+        RestClient.put(target_id_url, body_hash.to_json,
+                                    :'Date' => date_timestamp,
+                                    :'Authorization' => authorization_header,
+                                    :content_type => 'application/json',
+                                    :accept => :json)
+      rescue => e
+        e.response
+      end
+    end
+
+    # Database Summary Report
+    # https://developer.vuforia.com/resources/dev-guide/database-summary-report
+    def summary
+      date_timestamp = Time.now.httpdate
+      signature = self.build_signature('/summary', nil, 'GET', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" + signature
+      begin
+        RestClient.get(SUMMARY_URL, :'Date' => date_timestamp,
+                                    :'Authorization' => authorization_header)
+      rescue => e
+        e.response
+      end
+    end
+
+    # Retrieve a target from the cloud database
+    # https://developer.vuforia.com/resources/dev-guide/retrieving-target-cloud-database
+    def retrieve_target(target_id)
+      date_timestamp = Time.now.httpdate
+      target_id_url = TARGETS_URL + '/' + target_id
+      target_id_suburl = '/targets' + '/' + target_id
+      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" + signature
+      begin
+        RestClient.get(target_id_url, :'Date' => date_timestamp,
+                                      :'Authorization' => authorization_header)
+      rescue => e
+        e.response
+      end
+    end
+
+    # Target Summary Report
+    # https://developer.vuforia.com/resources/dev-guide/target-summary-report
+    def target_summary(target_id)
+      date_timestamp = Time.now.httpdate
+      target_id_url = SUMMARY_URL + '/' + target_id
+      target_id_suburl = '/summary' + '/' + target_id
+      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
+      authorization_header = "VWS " + @accesskey + ":" + signature
+      begin
+        RestClient.get(target_id_url, :'Date' => date_timestamp,
+                                      :'Authorization' => authorization_header)
+      rescue => e
+        e.response
+      end
+    end
+
+    def set_active_flag(target_id, active_flag)
+      date_timestamp = Time.now.httpdate
+      target_id_url = TARGETS_URL + '/' + target_id
+      target_id_suburl = '/targets' + '/' + target_id
+      body_hash = {:active_flag => active_flag}
+      signature = self.build_signature(target_id_suburl, body_hash, 'PUT', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" + signature
+      begin
+        RestClient.put(target_id_url, body_hash.to_json,
+                                      :'Date' => date_timestamp,
+                                      :'Authorization' => authorization_header,
+                                      :content_type => 'application/json',
+                                      :accept => :json)
+      rescue => e
+          e.response
+      end
+    end
+
+    # Delete a target in a cloud database
+    # https://developer.vuforia.com/library/articles/Solution/How-To-Delete-a-Target-Using-the-VWS-API
+    def delete_target(target_id)
+      # In order to delete the target, we have to set it to non-active.
+      # Therefore,first retrieve target info and act accordingly to target info
+      # returned
+      target_data = JSON.parse(retrieve_target(target_id)) # have to JSON.parse
+      # retrieve_target's results since they're in string format
+      target_result_code = target_data["result_code"]
+      if target_result_code != "AuthenticationFailure"
+        if target_result_code != "UnknownTarget"
+          target_active_flag = target_data["target_record"]["active_flag"]
+          target_status = target_data["status"]
+          if target_result_code == "Success"
+            if target_active_flag == true && target_status == "success"
+              return {:result_code => "TargetActive"}.to_json
+            elsif target_active_flag == false && target_status == "success"
+              # if we reached this point, the target is fine, inactive and
+              # ready to be deleted
+              date_timestamp = Time.now.httpdate
+              target_id_url = TARGETS_URL + '/' + target_id
+              target_id_suburl = '/targets' + '/' + target_id
+              signature = self.build_signature(target_id_suburl, nil, 'DELETE', date_timestamp)
+              raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+              authorization_header = "VWS " + @accesskey + ":" + signature
+                begin
+                  RestClient.delete(target_id_url,
+                                             :'Date' => date_timestamp,
+                                             :'Authorization' => authorization_header)
+                rescue => e
+                  e.response
+                end
+            else
+              return {:result_code => "#{target_status}"}.to_json
+            end
+          end
+        else
+          return {:result_code => "UnknownTarget"}.to_json
+        end
+      else
+        return {:result_code => "AuthenticationFailure"}.to_json
+      end
+    end
+
+    def list_duplicates(target_id)
+      date_timestamp = Time.now.httpdate
+
+      target_id_url = DUPLICATES_URL + '/' + target_id
+      target_id_suburl = '/duplicates' + '/' + target_id
+
+      signature = self.build_signature(target_id_suburl, nil, 'GET', date_timestamp)
+      raise ArgumentError.new('Signature returned nil. Aborting...') if signature == nil
+      authorization_header = "VWS " + @accesskey + ":" +  signature
+      begin
+        RestClient.get(target_id_url, :'Date' => date_timestamp,
+                                      :'Authorization' => authorization_header)
+      rescue => e
+        e.response
+      end
+    end
+
+  end
+end