kayakoapi-ruby 1.0.4 → 1.1.0

data/README.md

@@ -1,10 +1,6 @@
-# Kayakoapi::Ruby
+# Kayakoapi-Ruby
 
-Basic ruby app to generate Kayako API URLS.
-
-Currently prints the generated URL to the console.
-
-Minutely tested.
+Basic ruby gem to generate API signatures compatible with the [Kayako REST API](http://wiki.kayako.com/display/DEV/Kayako+REST+API)
 
 ## Installation
 
@@ -12,9 +8,9 @@ Add this line to your application's Gemfile:
 
     gem 'kayakoapi-ruby'
 
-And then execute:
+And then:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,18 +18,21 @@ Or install it yourself as:
 
 ## Usage
 
-    $ kayakoapi-ruby - u url-base -k app-key -s app-secret
+    require 'kayako-ruby'
 
-salt is randomly generated.
+    generator = KayakoApi.new('http://my.kayako.helpdesk/api', 'my-application-key', 'my-application-secret')
 
-e.g.
+    generator.url
+    #=> "http://my.kayako.helpdesk/api/index.php?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"
 
-    $ kayakoapi-ruby -u http://my-api-url/
+    generator.signature
+    #=> {:signature=>"%61%33%4F%6F%59%39%44%79%71%31%4F%6D%4D%6F%74%7A%47%44%4A%76%37%30%4F%6C%6F%48%74/%79%6D%6F%4C%70%43%77%57%52%57%41%6F%52%45%6B=", :salt=>"5265651781", :apikey=>"my-application-key"}
 
-Output:
+nb. you will need to add your own controller and action to the url.
 
-    $ 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
+If an error occurs, KayakoApi#url will return false.
 
+The salt is randomly generated, but included in the querystring (as per the [Kayako REST API](http://wiki.kayako.com/display/DEV/Kayako+REST+API).
 
 ## Contributing
 

data/lib/kayakoapi-ruby.rb

@@ -2,22 +2,25 @@ require "kayakoapi-ruby/version"
 require "kayakoapi-ruby/apisig"
 require "kayakoapi-ruby/urlgenerator"
 
-module Kayakoapi
-  require 'uri'
+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
+class KayakoApi
+  def initialize(base_url, app_key, app_secret)
+    @api_sig     = Kayakoapi::APISig.new(app_key, app_secret)
+    @url_builder = Kayakoapi::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
+  def url
+    @api_sig.new_signature.each { |key, value| @url_builder.append_to_url(key, value) }
+    begin
+      @url_builder.full_url
+    rescue => e
+      false
     end
   end
+
+  def signature
+    @api_sig.new_signature
+  end
 end
+

data/lib/kayakoapi-ruby/apisig.rb

@@ -1,5 +1,4 @@
 module Kayakoapi
-  # Required Libraries
   require 'openssl'
   require 'base64'
 
@@ -10,7 +9,7 @@ module Kayakoapi
     end
 
     def get_salt()
-      @last_salt = rand(10000000000).to_s
+      rand(10000000000).to_s
     end
 
     def hash(key, salt)
@@ -22,11 +21,11 @@ module Kayakoapi
     end
 
     def new_signature()
-      self.get_salt
-      hash = self.hash(@secret_key, @last_salt)
+      salt = self.get_salt
+      hash = self.hash(@secret_key, salt)
       b64hash = self.b64encode hash
-      @last_hash = URLGenerator::urlncode b64hash.strip
-      return { signature: @last_hash, salt: @last_salt, apikey: @api_key }
+      last_hash = URLGenerator::urlncode b64hash.strip
+      return { signature: last_hash, salt: salt, apikey: @api_key }
     end
   end
 end

data/lib/kayakoapi-ruby/exceptions.rb

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

data/lib/kayakoapi-ruby/urlgenerator.rb

@@ -2,9 +2,12 @@ module Kayakoapi
   require 'uri'
 
   class URLGenerator
+    attr_accessor :url_root, :params
+
     def initialize(url_root)
       @url_root = url_root
       @params = {}
+      @first_param = true
     end
 
     def append_to_url(key, value)
@@ -14,10 +17,15 @@ module Kayakoapi
     def full_url
       current_url = @url_root
       if @params.empty?
-        raise NoURLParametersException.new(msg: "Params hash is empty while attempting to build a URL.")
+        raise NoURLParameters.new(msg: "Params hash is empty while attempting to build a URL.")
       else
         @params.each do |key, value|
-          current_url += "&#{key}=#{value}"
+          if @first_param
+            current_url += "?#{key}=#{value}"
+            @first_param = false
+          else
+            current_url += "&#{key}=#{value}"
+          end
         end
         return current_url
       end
@@ -31,4 +39,4 @@ module Kayakoapi
       URI.escape(string, Regexp.new("[Generating an API Signature^#{URI::PATTERN::UNRESERVED}]"))
     end
   end
-end
+end

data/lib/kayakoapi-ruby/version.rb

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

data/spec/apisig_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
 require "kayakoapi-ruby/apisig"
-require "kayakoapi-ruby/urlgenerator"
 
 describe "APISig" do
   before :each do

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
+require 'simplecov'
+SimpleCov.start
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/spec/urlgenerator_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require "kayakoapi-ruby/urlgenerator"
+require "kayakoapi-ruby/exceptions"
+
+describe "URLGenerator" do
+  before :each do
+    @urlgen = Kayakoapi::URLGenerator.new("http://fake-url.com/")
+    @urlgen.append_to_url('one', 'valueone')
+    @urlgen.append_to_url('two', 'valuetwo')
+  end
+
+  it "should remember the url" do
+    @urlgen.url_root.should_not be_nil
+  end
+
+  it "should accept new parameters" do
+    @urlgen.append_to_url('troled', 'pigs')
+    @urlgen.params.should have_key('troled')
+    @urlgen.params['troled'].should eq 'pigs'
+  end
+
+  it "should return a string when asked to create a full_url" do
+    @urlgen.full_url.should eq "http://fake-url.com/?one=valueone&two=valuetwo"
+  end
+
+  it "should raise on failure" do
+    @urlgen.params = {}
+    expect{@urlgen.full_url}.to raise_error(Kayakoapi::NoURLParameters)
+  end
+
+  it "has a static method for encoding urls" do
+    Kayakoapi::URLGenerator::urlncode('tr o%ed').should eq "%74%72%20%6F%%65%64"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kayakoapi-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,8 +30,7 @@ dependencies:
 description: Ruby Shoes app to generate Kayako API URLs.
 email:
 - bulletraven@gmail.com
-executables:
-- kayakoapi
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -41,7 +40,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/kayakoapi
 - kayakoapi-ruby.gemspec
 - lib/kayakoapi-ruby.rb
 - lib/kayakoapi-ruby/apisig.rb
@@ -50,6 +48,7 @@ files:
 - lib/kayakoapi-ruby/version.rb
 - spec/apisig_spec.rb
 - spec/spec_helper.rb
+- spec/urlgenerator_spec.rb
 homepage: https://github.com/wadtech/kayakoapi-ruby
 licenses: []
 post_install_message: 
@@ -70,10 +69,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 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
+- spec/urlgenerator_spec.rb

data/bin/kayakoapi

@@ -1,42 +0,0 @@
-#!/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