sk_sdk 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/sk_sdk/README.rdoc

@@ -64,6 +64,8 @@ remember we only support HTTPS:
   =>
   https://my_company.salesking.eu/api
 
+For convenience we check if your url ends in /api and add if you forgot it!
+
 Create a single class
 
   require 'sk_sdk/base'

data/lib/sk_sdk/base.rb

@@ -39,8 +39,8 @@ class SK::SDK::Base < ActiveResource::Base
   # :user<String>:: if using httpBasic auth set to sk user login email
   # :password<String>:: if using httpBasic sk user password
   def self.set_connection(opts)
-    self.site     = opts[:site]
-    self.format   = :json # f*** xml
+    self.site   = site_api_url(opts[:site])
+    self.format = :json # f*** xml
     if opts[:token] #oAuth access token in header
       self.headers['Authorization'] = "Bearer #{opts[:token]}"
     else  
@@ -60,4 +60,11 @@ class SK::SDK::Base < ActiveResource::Base
       @headers ||= {}
     end
   end
+
+  private
+
+  def self.site_api_url(site)
+    site = site.gsub(/\/$/, '')
+    site =~ /\/api$/ ? site : "#{site}/api"
+  end
 end

data/lib/sk_sdk/oauth.rb

@@ -19,8 +19,8 @@ module SK::SDK
     # secret<String>:: oAuth app secret from SalesKing app registration
     # scope<String>:: permission your app requests
     # redirect_url<String>:: redirect url inside your app for auth dialog
-    # sk_url<String>:: SalesKing base url, * is replaced with users subdomain,
-    # default https://*.salesking.eu, optional
+    # sk_url<String>:: SalesKing base url, * is replaced with users subdomain, 
+    #   no trailing slash, optional defaults to https://*.salesking.eu
     # sub_domain<String>:: optinal, will probably be set later after a users
     # provided his subdomain
     def initialize(opts)
@@ -74,6 +74,13 @@ module SK::SDK
       ActiveSupport::JSON.decode(c.body_str)
     end
 
+    # The API url ist the salesking url of the current company + /api
+    # === Returns
+    # <String>:: base api url my-sub.salesking.eu/api
+    def sk_api_url
+      "#{sk_url}/api"
+    end
+
     # Each company has it's own subdomain so the url must be dynamic.
     # This is achieved by replacing the * with the subdomain in the instance
     # === Returns

data/lib/sk_sdk/sync.rb

@@ -64,9 +64,7 @@ module SK::SDK
     # field_map<Array[Hash{}]>::
     def fields=(field_map)
       @fields = []
-      field_map.each do |fld|
-        @fields << Field.new(fld)
-      end
+      field_map.each { |fld| @fields << Field.new(fld) }
       @fields
     end
 

data/sk_sdk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_sdk}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-10-03}
+  s.date = %q{2011-12-21}
   s.description = %q{Connect your business world with SalesKing. This gem gives ruby developers a jump-start for building SalesKing Business Apps. It provides classes to handle oAuth, make RESTfull API requests and parses JSON Schema  }
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

data/spec/sk_sdk/base_spec.rb

@@ -16,6 +16,26 @@ describe SK::SDK::Base, "make new class" do
     c.first_name.should == 'herbert' # implicit getter
   end
 
+  it "should set api url" do
+    opts = {:site => 'https://my.salesking.eu', :token=>'123'}
+    result = 'https://my.salesking.eu/api'
+
+    SK::SDK::Base.set_connection(opts)
+    SK::SDK::Base.site.to_s.should == result
+
+    opts[:site] = 'https://my.salesking.eu/'
+    SK::SDK::Base.set_connection(opts)
+    SK::SDK::Base.site.to_s.should == result
+
+    opts[:site] ='https://my.salesking.eu/api'
+    SK::SDK::Base.set_connection(opts)
+    SK::SDK::Base.site.to_s.should == result
+
+    opts[:site] = 'https://my.salesking.eu/api/'
+    SK::SDK::Base.set_connection(opts)
+    SK::SDK::Base.site.to_s.should == result
+  end
+
   it "should have properties as attributes" do
     c = Client.new :some_field => ''
     c.attributes.should == {"some_field"=>""}

data/spec/sk_sdk/oauth_spec.rb

@@ -16,6 +16,12 @@ describe SK::SDK::Oauth, "in general" do
     a.sub_domain = 'alki'
     a.sk_url.should == "http://alki.horsts-lokal.local"
   end
+  
+  it "should get salesking api url" do
+    a = SK::SDK::Oauth.new(@set)
+    a.sub_domain = 'alki'
+    a.sk_api_url.should == "http://alki.horsts-lokal.local/api"
+  end
 
   it "should get auth_dialog url" do
     a = SK::SDK::Oauth.new(@set)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 +02:00
+date: 2011-12-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency