vws 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58eb6f203dce595126186721e7b0f4c01861c94a
-  data.tar.gz: 529be7ff94d498b9c0b48c9d7fc535ac87c6d095
+  metadata.gz: 40511c3687d64aad2e56ad82ff056af559a59284
+  data.tar.gz: bb459c1ccb87491297b8cb913e5d6371527b4ceb
 SHA512:
-  metadata.gz: 9c692434c73fe0f300ef8c7bff52f0980e7c8c15accd72eb0ac037e940fbe2bb3588a1b3508e11c098e4a165fa631567488784e7c1d8ebceb72df45f1bd3053a
-  data.tar.gz: 383e15757243fa5f5529d76b02b2ea4c829f6f0e4faffcfa2e8c1c045086a89ab30acb5acc0eae395aa4c135a2a358761e65bbc2a1ae6ba57b0bfd6bba83092e
+  metadata.gz: 1be173437a87bd840936aa81131febdd10b095cda78cd45c8095c0058c50b7fc36b76f231baf6109426ec0ad14192d18eb0087ccf1687efc2768722c3eada774
+  data.tar.gz: 000b3675378731035b85351b6cf55f62195d64d916301e335bb690fa15ac9221b38ddad3652f8213dbe8b632df2681085c1c740c42dec95be23e8445f5277724

data/README.md

@@ -1,4 +1,4 @@
-# Vws (Vuforia Web Services ruby gem for API access)
+# 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
@@ -6,7 +6,7 @@ https://developer.vuforia.com/resources/dev-guide/managing-targets-cloud-databas
 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
+## Installation from source:
 
 
 Clone this repo onto your hard drive and cd into the root folder.
@@ -43,22 +43,26 @@ And then execute:
 
     bundle install
 
-This should work if you have installed the gem from source. I have not
-uploaded the gem to rubygems.org yet
 
+The gem has been uploaded to rubygems.org (http://rubygems.org/gems/vws), therefore you can simply issue:
 
-## Usage
+    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/resources/dev-guide/managing-targets-cloud-database-using-developer-api
+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
+    connection.summary
 
 For a list of targets in your database:
 
@@ -74,7 +78,8 @@ To activate or deactivate a target:
 
 To add a target to the database:
 
-    connection.add_target(target_name, file_path, width, active_flag)
+    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:
     
@@ -87,6 +92,15 @@ 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
 
@@ -95,15 +109,32 @@ of the folder by issuing:
 
     rspec spec
 
-## To do:
 
-  Implement some of the new vws apis and write better documentation :-)
+##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.

data/lib/vws.rb

@@ -13,6 +13,7 @@ module Vws
    BASE_URL = "https://vws.vuforia.com"
    TARGETS_URL = BASE_URL + "/targets"
    SUMMARY_URL = BASE_URL + "/summary"
+   DUPLICATES_URL = BASE_URL + "/duplicates"
 
   class Api
   
@@ -39,7 +40,7 @@ module Vws
         # json body data
         hexDigest = Digest::MD5.hexdigest(body_hash.to_json)
       else 
-        puts "Invalid request method";
+        puts "Invalid request method for signature method: " + http_verb
         return nil
       end
       
@@ -55,12 +56,15 @@ module Vws
 
     # 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, 
@@ -70,7 +74,9 @@ module Vws
       end
     end
 
-    def add_target(target_name, file_path, width, active_flag)
+    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)
@@ -79,6 +85,7 @@ module Vws
                     :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, 
@@ -91,7 +98,10 @@ module Vws
       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  
@@ -102,6 +112,7 @@ module Vws
                     :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, 
@@ -118,7 +129,8 @@ module Vws
     # 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) 
+      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, 
@@ -135,6 +147,7 @@ module Vws
       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,
@@ -166,8 +179,8 @@ module Vws
       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, 
@@ -180,7 +193,7 @@ module Vws
     end
 
     # Delete a target in a cloud database
-    # https://developer.vuforia.com/resources/dev-guide/deleting-target-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
@@ -202,6 +215,7 @@ module Vws
               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, 
@@ -221,6 +235,23 @@ module Vws
         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

data/lib/vws/version.rb

@@ -1,3 +1,3 @@
 module Vws
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/spec/vws_spec.rb

@@ -51,8 +51,8 @@ describe Vws do
   
   describe "should retrieve a single target info" do
     conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
-    puts "Info for targetid = ee408e0b9d054a04b0df85e0642494d2 \n"
-    response = conn.retrieve_target("ee408e0b9d054a04b0df85e0642494d2")
+    puts "Info for targetid = your_test_target_id \n"
+    response = conn.retrieve_target("your_test_target_id")
     puts JSON.pretty_generate(JSON.parse(response))
   end
   
@@ -60,8 +60,8 @@ describe Vws do
    
    describe "should retrieve a summary report of a single target" do
     conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
-    puts "Summary report targetid =  4098a76b155a4bfc9331f9ea4e858636 \n"
-    response = conn.target_summary("4098a76b155a4bfc9331f9ea4e858636")
+    puts "Summary report targetid =  your_test_target_id \n"
+    response = conn.target_summary("your_test_target_id")
     puts JSON.pretty_generate(JSON.parse(response))
   end
   
@@ -69,8 +69,8 @@ describe Vws do
   
   describe "delete target" do
     conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
-    puts "What happens if try to delete a file with targetid =   4098a76b155a4bfc9331f9ea4e858636 ?: \n"
-    response = conn.delete_target("4098a76b155a4bfc9331f9ea4e8536")
+    puts "What happens if try to delete a file with targetid = your_test_target_id ?: \n"
+    response = conn.delete_target("your_test_target_id")
     puts JSON.pretty_generate(JSON.parse(response))
   end
     
@@ -78,8 +78,8 @@ describe Vws do
    
    describe "set active to false" do
     conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
-    puts "Set target to false for targetid = ee408e0b9d054a04b0df85e0642494d2 \n"
-    response = conn.set_active_flag("ee408e0b9d054a04b0df85e0642494d2", false)
+    puts "Set target to false for targetid = your_test_target_id \n"
+    response = conn.set_active_flag("your_test_target_id", false)
     puts JSON.pretty_generate(JSON.parse(response))
   end
     

data/vws.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
 
   #development depedencies
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.1"
-  spec.add_development_dependency "rspec","~> 2.14"
+  spec.add_development_dependency "bundler", "~> 1.8.5"
+  spec.add_development_dependency "rake", "~> 10.4.2"
+  spec.add_development_dependency "rspec","~> 3.2.0"
   #spec.add_development_dependency "json","~> 1.8"
 
   #runtime dependencies
-  spec.add_runtime_dependency "rest-client", "~> 1.6"
+  spec.add_runtime_dependency "rest-client", "~> 1.7.3"
   spec.add_runtime_dependency "json", "~> 1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vws
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nick Kokkos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.8.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.8.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.3
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: This is a ruby gem that interacts with Vuforia Web service API for Cloud