vws 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58eb6f203dce595126186721e7b0f4c01861c94a
+  data.tar.gz: 529be7ff94d498b9c0b48c9d7fc535ac87c6d095
+SHA512:
+  metadata.gz: 9c692434c73fe0f300ef8c7bff52f0980e7c8c15accd72eb0ac037e940fbe2bb3588a1b3508e11c098e4a165fa631567488784e7c1d8ebceb72df45f1bd3053a
+  data.tar.gz: 383e15757243fa5f5529d76b02b2ea4c829f6f0e4faffcfa2e8c1c045086a89ab30acb5acc0eae395aa4c135a2a358761e65bbc2a1ae6ba57b0bfd6bba83092e

data/.gitignore

@@ -0,0 +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

data/.travis.yml

@@ -0,0 +1 @@
+.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,109 @@
+# Vws (Vuforia Web Services ruby gem for API access)
+
+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
+
+This should work if you have installed the gem from source. I have not
+uploaded the gem to rubygems.org yet
+
+
+## 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
+
+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)
+
+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
+
+
+## Spec
+
+Enter your server keys into vws_spec.rb file and run the specs at the root 
+of the folder by issuing:
+
+    rspec spec
+
+## To do:
+
+  Implement some of the new vws apis and write better documentation :-)
+
+
+## Contributing
+
+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

data/Rakefile

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

data/lib/vws.rb

@@ -0,0 +1,226 @@
+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"
+
+  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";
+        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
+    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)
+      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)
+      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)
+      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)
+      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)
+      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) 
+      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)
+      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)
+      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/resources/dev-guide/deleting-target-cloud-database
+    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)
+              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
+  
+  end
+end

data/lib/vws/version.rb

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

data/spec/vws_spec.rb

@@ -0,0 +1,96 @@
+require_relative '../lib/vws.rb'
+
+describe Vws do
+
+  VWS_ACCESSKEY = "your_vws_server_database_access_key"
+  VWS_SECRETKEY = "your_vws_server_database_secret_key"
+ 
+  
+#code below between begin and end was an attempt to read env variables from file
+=begin
+  describe "should connect to webservice and fail otherwise" do
+    YAML.load(File.open('spec/local_env.yml')).each do |key, value|
+      ENV[key.to_s] = value
+     end if File.exists?('spec/local_env.yml')
+       if defined?(ENV['VWS_ACCESSKEY']) && defined?(ENV['VWS_SECRETKEY'])
+         conn = Vws::Api.new(ENV['VWS_ACCESSKEY'], ENV['VWS_SECRETKEY'])
+         conn.inspect
+         #puts conn.list_targets
+         else
+         puts "ENV['VWS_ACCESSKEY'] && ENV['VWS_SECRETKEY' not defined"
+       end
+    end
+=end 
+
+  describe "should connect to webservice and show summary of the cloud database" do
+    conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
+    puts "Summary of the target database: \n"
+    response = conn.summary
+	puts JSON.pretty_generate(JSON.parse(response))
+  end
+
+  puts "\n"
+
+  describe "should connect to webservice and list all targets" do
+    conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
+    puts "Targets in remote database: \n"
+    response = conn.list_targets
+    puts JSON.pretty_generate(JSON.parse(response))
+  end
+    
+    puts "\n"
+
+  describe "should connect to webservice, upload file and fail if the file name is the same" do
+    conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
+    puts "Response after trying to add a file: \n"
+    response = conn.add_target("newtargetname", "spec/RGB_24bits.jpg", 150, true)
+    puts JSON.pretty_generate(JSON.parse(response))
+  end
+    
+   puts "\n"
+  
+  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 JSON.pretty_generate(JSON.parse(response))
+  end
+  
+    puts "\n"
+   
+   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 JSON.pretty_generate(JSON.parse(response))
+  end
+  
+  puts '/n'
+  
+  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 JSON.pretty_generate(JSON.parse(response))
+  end
+    
+    puts "\n"
+   
+   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 JSON.pretty_generate(JSON.parse(response))
+  end
+    
+    puts "\n"
+   
+   describe "should connect to webservice, upload Pitt picture and fail if the file name is the same" do
+    conn = Vws::Api.new(VWS_ACCESSKEY, VWS_SECRETKEY)
+    puts "Add Brat Pitt Picture: \n"
+    response = conn.add_target("pitt", "spec/pitt.jpg", 210, true)
+    puts JSON.pretty_generate(JSON.parse(response))
+  end
+  
+end
+

data/vws.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vws/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vws"
+  spec.version       = Vws::VERSION
+  spec.authors       = ["Nick Kokkos"]
+  spec.email         = ["nkokkos@gmail.com"]
+  spec.description   = %q{Vuforia web services api gem}
+  spec.summary       = %q{This is a ruby gem that interacts with Vuforia Web service API for Cloud database management. It uses the rest-client gem to handle the http/rest requests needed}
+  spec.homepage      = "http://github.com/nkokkos/vws"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  #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 "json","~> 1.8"
+
+  #runtime dependencies
+  spec.add_runtime_dependency "rest-client", "~> 1.6"
+  spec.add_runtime_dependency "json", "~> 1.8"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: vws
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Kokkos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Vuforia web services api gem
+email:
+- nkokkos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vws.rb
+- lib/vws/version.rb
+- spec/Grayscale_8bits.png
+- spec/RGB_24bits.jpg
+- spec/cumbria_woodland02859.jpg
+- spec/pitt.jpg
+- spec/vws_spec.rb
+- vws.gemspec
+homepage: http://github.com/nkokkos/vws
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: This is a ruby gem that interacts with Vuforia Web service API for Cloud
+  database management. It uses the rest-client gem to handle the http/rest requests
+  needed
+test_files:
+- spec/Grayscale_8bits.png
+- spec/RGB_24bits.jpg
+- spec/cumbria_woodland02859.jpg
+- spec/pitt.jpg
+- spec/vws_spec.rb