sk_sdk 0.0.1 → 0.0.2

data/README.rdoc

@@ -7,7 +7,6 @@ Still in a very early stage
 
 == Install
 
-
     gem install sk_sdk
 
 Dependencies (gem's):
@@ -15,4 +14,11 @@ Dependencies (gem's):
 * activeresupport
 * curb
 
+== Usage
+
+The classes must be explicitly required
+
+  require 'sk_sdk/sign_req'
+  require 'sk_sdk/oauth'
+
 Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/sk_sdk/signed_request.rb

@@ -1,11 +1,11 @@
 require 'base64'
 require "active_support/json"
 require 'openssl'
+
 module SK::SDK
   # Decode and validate signed requests which Salesking sends to canvas pages
   # and PubSub subscribers
   class SignedRequest
-
     attr_reader :signed_request, :app_secret, :data, :payload, :sign
 
     def initialize(signed_request, app_secret)
@@ -38,13 +38,35 @@ module SK::SDK
       @sign == OpenSSL::HMAC.hexdigest('sha256', @app_secret, @payload)
     end
 
-    def encode(str)
+    # Base64 url encode a string and sign it using the given secret. The hmac
+    # signature and the encoded string are joined by . and returned
+    #
+    # === Parameter
+    # str<String>:: the string to encode
+    # secret<String>:: the string used to create the signature
+    # === Returns
+    # <String>:: hmac-sign.encoded-string
+    def self.signed_param(str, secret)
       # base65 url encode the json, remove trailing-padding =
-      enc_str = [str].pack('m').tr('+/','-_').gsub("\n",'').gsub(/=+$/, '' )
+      enc_str = base64_url_encode(str)
       # create hmac signature
-      hmac_sig = OpenSSL::HMAC.hexdigest('sha256',@app_secret, enc_str)
+      hmac_sig = OpenSSL::HMAC.hexdigest('sha256',secret, enc_str)
       # glue together and return
       [hmac_sig, enc_str].join('.')
     end
+
+    # Base64 url encode a string:
+    #  NO padding = is added
+    # + is replaced by -
+    # / is replaced by _
+    #
+    # === Parameter
+    # str<String>:: the string to encode
+    # === Returns
+    # <String>:: base64url-encoded
+    def self.base64_url_encode(str)
+      [str].pack('m').tr('+/','-_').gsub("\n",'').gsub(/=+$/, '' )
+    end
+
   end
 end

data/sk_sdk.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sk_sdk}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Georg Leciejewski"]
+  s.date = %q{2011-03-10}
+  s.description = %q{Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. Under the hood it provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  }
+  s.email = %q{gl@salesking.eu}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/sk_sdk.rb",
+    "lib/sk_sdk/oauth.rb",
+    "lib/sk_sdk/signed_request.rb",
+    "sk_sdk.gemspec",
+    "spec/oauth_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/salesking/sk_sdk}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{SalesKing SDK Ruby}
+  s.test_files = [
+    "spec/oauth_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<curb>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<curb>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<curb>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 +01:00
+date: 2011-03-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,6 +76,7 @@ files:
 - lib/sk_sdk.rb
 - lib/sk_sdk/oauth.rb
 - lib/sk_sdk/signed_request.rb
+- sk_sdk.gemspec
 - spec/oauth_spec.rb
 has_rdoc: true
 homepage: http://github.com/salesking/sk_sdk