kayakoapi-ruby 1.0.4

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Mellett
+
+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,66 @@
+# Kayakoapi::Ruby
+
+Basic ruby app to generate Kayako API URLS.
+
+Currently prints the generated URL to the console.
+
+Minutely tested.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kayakoapi-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kayakoapi-ruby
+
+## Usage
+
+    $ kayakoapi-ruby - u url-base -k app-key -s app-secret
+
+salt is randomly generated.
+
+e.g.
+
+    $ kayakoapi-ruby -u http://my-api-url/
+
+Output:
+
+    $ Generated URL: http://my-api-url/api/index.php?/Controller/Action&signature=%57%56%4A%65%4D%65+%31%4A%6B%34%33%4E%32%6C%56%6E/%70%4D%6D%33%5A%57%79%31%4F%51%31%50%62%34%76%67%74%47%41%4E%67%4A%42%35%45=&salt=5870184239&apikey=1234567890
+
+
+## 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
+
+## License
+
+Copyright (c) 2013 Peter Mellett
+
+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/Rakefile

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

data/bin/kayakoapi

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'kayakoapi-ruby'
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: kayakoapi-ruby [options]"
+
+  opts.on("-u", "--url [URL]", "Base URL for your API Call") do |url|
+    options[:url] = url
+  end
+
+  opts.on("-k", "--key [KEY]", "API Key from your Kayako Helpdesk") do |key|
+    options[:app_key] = key
+  end
+
+  opts.on("-s", "--secret [SECRET]", "API Secret from your Kayako Helpdesk") do |secret|
+    options[:secret] = secret
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts "Kayako API URL Generator: v#{Kayakoapi::VERSION}"
+    exit
+  end
+end.parse!
+
+[:url, :app_key, :secret].each do |setting|
+  if options[setting] == nil
+    print  "Please enter a value for #{setting}: "
+    options[setting] = gets
+  end
+end
+
+app = Kayakoapi::App.new(options[:url], options[:app_key], options[:secret])
+app.run

data/kayakoapi-ruby.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kayakoapi-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kayakoapi-ruby"
+  gem.version       = Kayakoapi::VERSION
+  gem.authors       = ["Peter Mellett"]
+  gem.email         = ["bulletraven@gmail.com"]
+  gem.description   = %q{Ruby Shoes app to generate Kayako API URLs.}
+  gem.summary       = %q{Ruby Shoes app to generate Kayako Resolve API URLs.}
+  gem.homepage      = "https://github.com/wadtech/kayakoapi-ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec", ["~> 2.12"]
+end

data/lib/kayakoapi-ruby/apisig.rb

@@ -0,0 +1,32 @@
+module Kayakoapi
+  # Required Libraries
+  require 'openssl'
+  require 'base64'
+
+  class APISig
+    def initialize(key, secret)
+      @api_key = key
+      @secret_key = secret
+    end
+
+    def get_salt()
+      @last_salt = rand(10000000000).to_s
+    end
+
+    def hash(key, salt)
+      OpenSSL::HMAC.digest('sha256', key, salt)
+    end
+
+    def b64encode(hash)
+      signature = Base64.encode64(hash);
+    end
+
+    def new_signature()
+      self.get_salt
+      hash = self.hash(@secret_key, @last_salt)
+      b64hash = self.b64encode hash
+      @last_hash = URLGenerator::urlncode b64hash.strip
+      return { signature: @last_hash, salt: @last_salt, apikey: @api_key }
+    end
+  end
+end

data/lib/kayakoapi-ruby/exceptions.rb

@@ -0,0 +1,7 @@
+module Kayakoapi
+  class NoURLParametersException < Exception
+    def initialize(data)
+      @data = data
+    end
+  end
+end

data/lib/kayakoapi-ruby/urlgenerator.rb

@@ -0,0 +1,34 @@
+module Kayakoapi
+  require 'uri'
+
+  class URLGenerator
+    def initialize(url_root)
+      @url_root = url_root
+      @params = {}
+    end
+
+    def append_to_url(key, value)
+      @params[key] = value
+    end
+
+    def full_url
+      current_url = @url_root
+      if @params.empty?
+        raise NoURLParametersException.new(msg: "Params hash is empty while attempting to build a URL.")
+      else
+        @params.each do |key, value|
+          current_url += "&#{key}=#{value}"
+        end
+        return current_url
+      end
+    end
+
+    def first_param?
+      @first_param
+    end
+
+    def self.urlncode(string)
+      URI.escape(string, Regexp.new("[Generating an API Signature^#{URI::PATTERN::UNRESERVED}]"))
+    end
+  end
+end

data/lib/kayakoapi-ruby/version.rb

@@ -0,0 +1,3 @@
+module Kayakoapi
+  VERSION = "1.0.4"
+end

data/lib/kayakoapi-ruby.rb

@@ -0,0 +1,23 @@
+require "kayakoapi-ruby/version"
+require "kayakoapi-ruby/apisig"
+require "kayakoapi-ruby/urlgenerator"
+
+module Kayakoapi
+  require 'uri'
+
+  class App
+    def initialize(base_url, app_key, app_secret)
+      @api_sig = APISig.new(app_key, app_secret)
+      @url_builder = URLGenerator.new(base_url)
+    end
+
+    def run
+      @api_sig.new_signature.each { |key, value| @url_builder.append_to_url(key, value) }
+      begin
+        puts "Generated URL: #{@url_builder.full_url}"
+      rescue => e
+        puts "URL Could not be generated, no parameters were appended to the URL."
+      end
+    end
+  end
+end

data/spec/apisig_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require "kayakoapi-ruby/apisig"
+require "kayakoapi-ruby/urlgenerator"
+
+describe "APISig" do
+  before :each do
+    @apisig = Kayakoapi::APISig.new("one", "two")
+  end
+
+  it "should generate a random salt" do
+    @salt = @apisig.get_salt
+    @salt.should_not be_nil
+  end
+
+  it "should hash a key and a salt" do
+    hash = @apisig.hash("secret key", "random salt")
+    hash.should eq "\xDA>\xD7\x8B>\x150\xC2\x98\r\xA4\xA6\\o\xFDf\xE1&o\x19N\xF6\xFE\xEF0\x1C7\rR\x99/O"
+  end
+
+  it "should encode a string into base64" do
+    string = @apisig.b64encode("String")
+    string.should eq "U3RyaW5n\n"
+  end
+
+  it "should return a hash when asked to create a new signature" do
+    urlgen = double("urlgenerator")
+    urlgen.stub!(:urlencode).and_return "encoded"
+
+    result = @apisig.new_signature
+    result[:signature].should_not be_nil
+    result[:salt].should_not be_nil
+    result[:apikey].should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: kayakoapi-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Peter Mellett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: Ruby Shoes app to generate Kayako API URLs.
+email:
+- bulletraven@gmail.com
+executables:
+- kayakoapi
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kayakoapi
+- kayakoapi-ruby.gemspec
+- lib/kayakoapi-ruby.rb
+- lib/kayakoapi-ruby/apisig.rb
+- lib/kayakoapi-ruby/exceptions.rb
+- lib/kayakoapi-ruby/urlgenerator.rb
+- lib/kayakoapi-ruby/version.rb
+- spec/apisig_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wadtech/kayakoapi-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Shoes app to generate Kayako Resolve API URLs.
+test_files:
+- spec/apisig_spec.rb
+- spec/spec_helper.rb