sk_sdk 0.0.4 → 0.0.5

data/README.rdoc

@@ -16,7 +16,7 @@ Dependencies (gem's):
 
 == Classes
 
-All classes must be explicitly required
+All classes must be explicitly required so each can be used on their own.
 
   require 'sk_sdk/signed_request'
   require 'sk_sdk/oauth'
@@ -37,6 +37,12 @@ PubSub/Webhook callbacks.
 Create classes out if thin air to CRUD SalesKing object's using activeresource
 {see README}[https://github.com/salesking/sk_sdk/blob/master/lib/sk_sdk/README_ArCli.rdoc]
 
+This client uses HTTPBasic Auth with email/password and does NOT use oAuth. This 
+authentication method might be kicked in the future, as oAuth2 is considered
+safer.
+If you have found a convenient way to enable ActiveResource with oAuth2 we are
+glad to hear from you.
+
 == Usage
 
 Read specs: https://github.com/salesking/sk_sdk/tree/master/spec/sk_sdk

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/sk_sdk/README_ArCli.rdoc

@@ -34,11 +34,13 @@ First create the classes:
     SK::SDK::ArCli.make(:credit_note, King)
 
 Now the classes are available they need connection settings first. Those Must
-be set for each class separate.
+be set for each class separate and you MUST provide the full url using the right
+protocol http/https + SUBDomain + salesking url + /api
+Our production system only supports HTTPS.
 
   [Client, CreditNote].each do |i|
-    i.send(:set_connection, {:site => 'my_sub.salesking.eu',
-                              :user => 'demo@salesking.eu',
+    i.send(:set_connection, {:site => 'https://my_sub.salesking.eu/api',
+                              :user => 'my-users@login-email.com',
                               :password => 'password' })
   client = Client.new(:last_name=> 'Meister')
   client.first_name = "Bau"
@@ -59,7 +61,7 @@ using your SalesKing login email and password.
 
 For a production environment be advised to create a user, per api client, and
 restrict his rights with our build in role-system!
-SalesKing only supports HTTPS.
+
 
 === API Tutorial and Tools
 
@@ -75,6 +77,8 @@ http-basic-auth can be used.
 
 == Tests / Specs
 
+Take a look into spec/resources to see a how-to
+
   rake coverage
 
 Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/lib/sk_sdk/ar_cli.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'sk_sdk'
 require 'active_resource'
 require 'active_resource/version'
 # patches are for specific AR version
@@ -10,9 +11,6 @@ elsif ActiveResource::VERSION::MAJOR < 3
   require 'sk_sdk/ar_cli/patches/ar2/base'
 end
 
-# schema gem
-#require 'sk_api_schema'
-
 module SK::SDK
   class ArCli
     # Create a class for a given name

data/lib/sk_sdk/oauth.rb

@@ -1,5 +1,6 @@
 require 'cgi'
 require 'curb'
+require 'sk_sdk'
 module SK::SDK
   # Authenticate your SalesKing App using oAuth2. This class provides helpers
   # to create the token & dialog url and to get an access token

data/lib/sk_sdk/signed_request.rb

@@ -1,6 +1,7 @@
 require 'base64'
 require "active_support/json"
 require 'openssl'
+require 'sk_sdk'
 
 module SK::SDK
   # Decode and validate signed requests which Salesking sends to canvas pages

data/sk_sdk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_sdk}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-03-28}
+  s.date = %q{2011-05-01}
   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 = [
@@ -30,9 +30,15 @@ Gem::Specification.new do |s|
     "lib/sk_sdk/oauth.rb",
     "lib/sk_sdk/signed_request.rb",
     "sk_sdk.gemspec",
+    "spec/resources_spec_helper.rb",
     "spec/settings.yml",
     "spec/sk_sdk/ar_cli_spec.rb",
     "spec/sk_sdk/oauth_spec.rb",
+    "spec/sk_sdk/resources/README.rdoc",
+    "spec/sk_sdk/resources/clients_spec.rb",
+    "spec/sk_sdk/resources/credit_note_spec.rb",
+    "spec/sk_sdk/resources/invoice_spec.rb",
+    "spec/sk_sdk/resources/product_spec.rb",
     "spec/sk_sdk/signed_request_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -41,8 +47,13 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.6.2}
   s.summary = %q{SalesKing SDK Ruby}
   s.test_files = [
+    "spec/resources_spec_helper.rb",
     "spec/sk_sdk/ar_cli_spec.rb",
     "spec/sk_sdk/oauth_spec.rb",
+    "spec/sk_sdk/resources/clients_spec.rb",
+    "spec/sk_sdk/resources/credit_note_spec.rb",
+    "spec/sk_sdk/resources/invoice_spec.rb",
+    "spec/sk_sdk/resources/product_spec.rb",
     "spec/sk_sdk/signed_request_spec.rb",
     "spec/spec_helper.rb"
   ]

data/spec/resources_spec_helper.rb

@@ -0,0 +1,43 @@
+CONNECTION = {
+    :site => "https://demo.dev.salesking.eu/api/",
+#    :site => "http://demo.salesking.local:3000/api/",
+    :user => "demo@salesking.eu",
+    :password => "demouser",
+    :format => :json
+} unless defined?(CONNECTION)
+
+# create all classes and set their connection
+# instead of
+# SK::SDK::ArCli.make(:client) unless Object.const_defined?('Client')
+# Client.set_connection( CONNECTION )
+[:client, :address, :credit_note, :line_item, :invoice, :product].each do |name|
+  class_name = "#{name}".camelize
+  SK::SDK::ArCli.make(class_name) unless Object.const_defined?(class_name)
+  class_name.constantize.set_connection( CONNECTION )
+end
+
+
+# check if a SalesKing instance is available by calling /users/current.json
+def sk_available?
+  SK::SDK::ArCli.make(:user) unless Object.const_defined?('User')
+  User.set_connection( CONNECTION )
+  begin
+    User.get(:current)
+  rescue Errno::ECONNREFUSED #ActiveResource::ResourceNotFound => e
+    return false
+  end
+
+end
+
+
+def delete_test_data(doc, client)
+  doc.destroy
+  client.destroy
+  lambda {
+    doc = Invoice.find(doc.id)
+  }.should raise_error(ActiveResource::ResourceNotFound)
+  lambda {
+    client = Client.find(client.id)
+  }.should raise_error(ActiveResource::ResourceNotFound)
+end
+

data/spec/sk_sdk/ar_cli_spec.rb

@@ -1,12 +1,8 @@
 require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
 
 describe SK::SDK::ArCli, "make new class" do
 
-  before :all do
-    SK::SDK::ArCli.make(:client)
-    Client.set_connection( CONNECTION )
-  end
-
   it "should create class" do
     c = Client.new
     c.first_name = 'herbert' # implicit setter
@@ -42,23 +38,4 @@ describe SK::SDK::ArCli, "make new class" do
       c.id
     }.should_not raise_error(RuntimeError)
   end
-end
-
-if sk_available?
-  describe SK::SDK::ArCli, "with real connection" do
-
-    before :all do
-      SK::SDK::ArCli.make(:client) unless Object.const_defined?('Client')
-      Client.set_connection( CONNECTION )
-    end
-
-    it "should save" do
-      c = Client.new :organisation=>"Rack'n Roll"
-      c.save.should be_true
-      c.id.should_not be_empty
-      c.number.should_not be_empty
-    end
-  end
-else
-  puts "Sorry your local SalesKing server ain't running, skipping real connections tests"
-end
+end

data/spec/sk_sdk/resources/README.rdoc

@@ -0,0 +1,9 @@
+= SalesKing SDK Resources Specs
+
+The specs in here serve mainly as an example using the ActiveResource client
+with username+password to CRUD objects against a real sk server.
+
+Of course we also have internal specs for all api controllers but sometimes a
+view from the outside can be revealing.
+
+Please be nice and DON'T misuse those tests!

data/spec/sk_sdk/resources/clients_spec.rb

@@ -0,0 +1,102 @@
+require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
+
+unless sk_available?
+  puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
+else
+  
+  describe Client, "with real connection" do
+
+    before :all do
+      @client = Client.new(:organisation=>'from testing API2')
+      @client.save
+    end
+
+    after :all do
+      #delete test client
+      @client.destroy
+      lambda {
+        client = Client.find(@client.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should save" do
+      c = Client.new :organisation=>"Rack'n Roll"
+      c.save.should be_true
+      c.id.should_not be_empty
+      c.number.should_not be_empty
+    end
+
+    it "should fail create a client" do
+      client = Client.new(:organisation=>'from testing API2')
+      client.bank_iban = 'safasf'
+      client.save.should == false
+      client.errors.count.should == 1
+      client.errors.full_messages.should ==  ["Bank iban is invalid"]
+    end
+
+    it "should find a single client" do
+      client = Client.find(@client.id)
+      client.organisation.should == @client.organisation
+    end
+
+    it "should find clients" do
+      clients = Client.find(:all)
+      clients.should_not be_empty
+    end
+  end
+
+
+  describe Client, "with addresses" do
+
+    before :all do
+      #setup test client to work with
+      @client = Client.new(:organisation=>'Second from testing API2',
+                            :addresses => [{ :zip => '50374', :city => 'Cologne' }] )
+
+      @client.save
+    end
+
+    after :all do
+      @client.destroy
+      lambda {
+        client = Client.find(@client.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should create an address" do
+      @client.addresses.length.should == 1
+      @client.addresses.first.zip.should == '50374'
+    end
+
+    it "should edit an address" do
+      @client.addresses.length.should == 1
+     # puts @client.addresses.inspect
+      @client.addresses[0].zip = '40001'
+      @client.save
+      @client.addresses.length.should == 1
+      @client.addresses.first.zip.should == '40001'
+    end
+
+    it "should add an address" do
+      cnt_before = @client.addresses.length
+      adr = Address.new( { :zip => '37700', :city => 'Cologne' } )
+      @client.addresses << adr
+      @client.save
+      @client.addresses.length.should == cnt_before+1
+    end
+
+    it "should destroy an address" do
+      cnt_before = @client.addresses.length
+#      adr = Address.new( { :zip => '696969', :city => 'Go eat It' } )
+#      @client.addresses << adr
+#      @client.save
+      @client.addresses.last._delete = 1
+      @client.save
+      @client.reload
+      @client.addresses.length.should == cnt_before-1
+    end
+  end
+
+
+end

data/spec/sk_sdk/resources/credit_note_spec.rb

@@ -0,0 +1,113 @@
+require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
+
+unless sk_available?
+  puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
+else
+
+  describe CreditNote, "in general" do
+
+    before :all do
+      #setup test doc to work with
+      # create client
+      @client = Client.new(:organisation=>'Credit Note API-Tester')
+      @client.save.should be_true
+      @doc = CreditNote.new()
+      @doc.title = 'A Document from the API'
+      @doc.client_id = @client.id
+      @doc.save.should be_true
+    end
+
+    after :all do
+      #delete test doc
+      @doc.destroy
+      @client.destroy
+      lambda {
+        doc = CreditNote.find(@doc.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+      lambda {
+        client = Client.find(@client.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should create a doc and use default before after text" do
+      @doc.errors.should be_empty
+      @doc.notes_before.should_not be_empty
+      @doc.new?.should be_false
+    end
+
+    it "should fail create a doc" do
+      doc = CreditNote.new()
+      doc.save.should == false
+      doc.errors.count.should == 1
+      doc.errors.on(:client_id).should == "can't be blank"
+    end
+
+    it "should find a doc" do
+      doc = CreditNote.find(@doc.id)
+      doc.title.should == @doc.title
+    end
+
+    it "should edit a doc" do
+      old_lock_version = @doc.lock_version
+      @doc.notes_before = 'You will recieve the amout of:'
+      @doc.notes_before = 'Payment made to you bank Account'
+      @doc.title = 'Changed doc title'
+
+      @doc.save.should be_true
+      @doc.lock_version.should > old_lock_version # because save returns the data
+    end
+
+    it "should fail edit a doc" do
+      @doc.client_id = ''
+      @doc.save.should == false
+      @doc.errors.count.should == 1
+      @doc.errors.on(:client_id).should == "can't be blank"
+    end
+  end
+
+  describe CreditNote, "with line items" do
+
+    before :all do
+      @client = Client.new(:organisation=>'Credit Note API-Tester')
+      @client.save.should be_true
+      #setup test doc to work with
+      @doc = CreditNote.new :client_id => @client.id,
+                            :line_items =>[{ :position=>1, :description => 'Pork Chops',
+                                              :quantity => 12, :price_single =>'10.00'}]
+      @doc.save.should be_true
+    end
+
+    after :all do
+      @client.destroy #also destroys all docs
+  #    @doc.destroy
+      lambda {
+        doc = CreditNote.find(@doc.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should create a line item" do
+      @doc.line_items.length.should == 1
+      @doc.line_items.first.description.should == 'Pork Chops'
+      @doc.price_total.should == 120.0
+    end
+
+    it "should edit line item" do
+      @doc.line_items[0].description = 'Egg Sandwich'
+      @doc.save
+      @doc.line_items.length.should == 1
+      @doc.line_items.first.description.should == 'Egg Sandwich'
+    end
+
+    it "should add line item" do
+      item = LineItem.new :position=>2, :description => 'Goat-Pie', 
+                          :price_single => 10, :quantity=>10
+      @doc.line_items << item
+      @doc.save
+      @doc.line_items.length.should == 2
+      @doc.price_total.should == 220.0
+  #    @doc.line_items[0].zip = '40001'
+  #    @doc.line_items.[1].zip.should == '40001'
+    end
+  end
+end

data/spec/sk_sdk/resources/invoice_spec.rb

@@ -0,0 +1,152 @@
+require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
+
+unless sk_available?
+  puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
+else
+
+describe Invoice, "in general" do
+
+  before :all do
+    @client = Client.new(:organisation=>'Invoice API-Tester')
+    @client.save.should be_true
+    @doc = Invoice.new()
+    @doc.title = 'A Document from the API'
+    @doc.client_id = @client.id
+    @doc.save.should be_true
+  end
+
+  after :all do
+    delete_test_data(@doc, @client)
+  end
+
+  it "should find a doc" do
+    doc = Invoice.find(@doc.id)
+    doc.title.should == @doc.title
+  end
+end
+
+describe Invoice, "a new invoice" do
+
+  before :all do
+    @client = Client.new(:organisation=>'Invoice API-Tester')
+    @client.save.should be_true
+  end
+  after :all do
+    @client.destroy
+  end
+
+  it "should create a doc" do
+    doc = Invoice.new()
+    doc.title = 'A Document from the API'
+    doc.notes_before = 'Your shiny new invoice [number]'
+    doc.notes_after = 'Please pay me'
+    doc.client_id = @client.id
+    doc.save
+    doc.errors.should be_empty
+    doc.new?.should be_false
+    doc.notes_before.should == 'Your shiny new invoice [number]'
+    doc.destroy
+  end
+
+  it "should create a doc with default before after texts" do
+    doc = Invoice.new()
+    doc.title = 'A Document from the API'
+    doc.client_id = @client.id
+    doc.save
+    doc.errors.should be_empty
+    doc.new?.should be_false
+    doc.notes_before.should_not be_empty
+    doc.destroy
+  end
+
+  it "should fail create a doc" do
+    doc = Invoice.new()
+    doc.save.should == false
+    doc.errors.count.should == 1
+    doc.errors.on(:client_id).should == "can't be blank"
+  end
+
+end
+
+describe Invoice, "Edit an invoice" do
+
+  before :all do
+    #setup test doc to work with
+    # create client
+    @client = Client.new(:organisation=>'Invoice API-Tester')
+    @client.save.should be_true
+    @doc = Invoice.new()
+    @doc.title = 'A Document from the API'
+    @doc.notes_before = 'Your invoice [number]'
+    @doc.client_id = @client.id
+    @doc.save.should be_true
+  end
+
+  after :all do
+    delete_test_data(@doc, @client)
+  end
+
+  it "should edit a doc" do
+    old_lock_version = @doc.lock_version
+    @doc.notes_before.should == 'Your invoice [number]'
+    @doc.notes_before = 'You will recieve the amout of:'
+    @doc.notes_after = 'Payment made to you bank Account'
+    @doc.title = 'Changed doc title'
+
+    @doc.save.should be_true
+    @doc.lock_version.should > old_lock_version # because save returns the data
+    @doc.notes_before.should == 'You will recieve the amout of:'
+  end
+
+  it "should fail edit without a client" do
+    @doc.client_id = ''
+    @doc.save.should == false
+    @doc.errors.count.should == 1
+    @doc.errors.on(:client_id).should == "can't be blank"
+  end
+end
+
+describe Invoice, "with line items" do
+
+  before :all do
+    @client = Client.new(:organisation=>'Credit Note API-Tester')
+    @client.save.should be_true
+    #setup test doc to work with
+    @doc = Invoice.new(:client_id => @client.id,
+                        :line_items => [{ :position=>1, :description => 'Pork Chops',
+                                           :quantity => 12, :price_single =>'10.00' }] )
+    @doc.save.should be_true
+  end
+
+  after :all do
+    delete_test_data(@doc, @client)
+  end
+
+  it "should create a line item" do
+    @doc.line_items.length.should == 1
+    @doc.line_items.first.description.should == 'Pork Chops'
+    @doc.price_total.should == 120.0
+  end
+
+  it "should edit line item" do
+    @doc.line_items[0].description = 'Egg Sandwich'
+    @doc.save
+    @doc.line_items.length.should == 1
+    @doc.line_items.first.description.should == 'Egg Sandwich'
+  end
+
+  it "should add line item" do
+    item = LineItem.new( {  :position=>2, :description => 'Goat-Pie', :price_single => 10, :quantity=>10} )
+    product = Product.new(:name=>'Eis am Stiel', :price => 1.50, :tax=>19, :description => 'Mmmhh lecker Eis')
+    product.save.should be_true
+    item1 = LineItem.new( { :position=>3, :use_product => 1, :product_id=> product.id, :quantity => 10 } )
+    @doc.line_items << item
+    @doc.line_items << item1
+    @doc.save
+    @doc.line_items.length.should == 3
+    @doc.price_total.should == 235.0
+  end
+
+end
+end

data/spec/sk_sdk/resources/product_spec.rb

@@ -0,0 +1,63 @@
+require 'spec/spec_helper'
+require 'spec/resources_spec_helper'
+
+unless sk_available?
+  puts "Sorry cannot connect to your SalesKing server, skipping real connections tests. Please check connection settings in spec_helper"
+else
+
+  describe Product, "in general" do
+
+    before :all do
+      #setup test product to work with
+      @product = Product.new(:name=>'Eis am Stiel', :price => 1.50)
+      @product.save.should be_true
+    end
+
+    after :all do
+      #delete test product
+      @product.destroy
+      lambda {
+        product = Product.find(@product.id)
+      }.should raise_error(ActiveResource::ResourceNotFound)
+    end
+
+    it "should create a product" do
+      @product.number.should_not be_nil
+      @product.price.should == 1.50
+      @product.new?.should be_false
+    end
+
+    it "should fail create a product without name" do
+      product = Product.new(:price => 2.50)
+      product.save.should == false
+      product.errors.count.should == 1
+      product.errors.full_messages.should ==  ["Name can't be blank"]
+    end
+
+    it "should fail create a product with empty price" do
+      product = Product.new(:name => 'No brain', :price =>' ')
+      product.save.should be_false
+      product.errors.full_messages.should ==  ["Price can't be blank", "Price is not a number"]
+    end
+
+    it "should find a product by id" do
+      product = Product.find(@product.id)
+      product.name.should == @product.name
+    end
+
+    it "should edit a product" do
+      @product.name = 'A new product name'
+      @product.lock_version.should == 0
+      @product.save
+      @product.lock_version.should == 1 # because save returns the data
+    end
+
+    it "should fail edit a product" do
+      @product.name = ''
+      @product.save.should == false
+      @product.errors.count.should == 1
+      @product.errors.on(:name).should ==  "can't be blank"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -15,21 +15,3 @@ puts "Testing with ActiveResource v: #{ActiveResource::VERSION::STRING}."
 def load_settings
   @set ||= YAML.load_file(File.join(File.dirname(__FILE__), 'settings.yml'))
 end
-
-CONNECTION = {
-    :site => "http://demo.salesking.local:3000/api/",
-    :user => "demo@salesking.eu",
-    :password => "demo",
-    :format => :json
-} unless defined?(CONNECTION)
-
-def sk_available?
-  SK::SDK::ArCli.make(:user) unless Object.const_defined?('User')
-  User.set_connection( CONNECTION )
-  begin
-    User.get(:current)
-  rescue Errno::ECONNREFUSED #ActiveResource::ResourceNotFound => e
-    return false
-  end
-
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_sdk
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
+date: 2011-05-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,9 +97,15 @@ files:
 - lib/sk_sdk/oauth.rb
 - lib/sk_sdk/signed_request.rb
 - sk_sdk.gemspec
+- spec/resources_spec_helper.rb
 - spec/settings.yml
 - spec/sk_sdk/ar_cli_spec.rb
 - spec/sk_sdk/oauth_spec.rb
+- spec/sk_sdk/resources/README.rdoc
+- spec/sk_sdk/resources/clients_spec.rb
+- spec/sk_sdk/resources/credit_note_spec.rb
+- spec/sk_sdk/resources/invoice_spec.rb
+- spec/sk_sdk/resources/product_spec.rb
 - spec/sk_sdk/signed_request_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -137,7 +143,12 @@ signing_key:
 specification_version: 3
 summary: SalesKing SDK Ruby
 test_files: 
+- spec/resources_spec_helper.rb
 - spec/sk_sdk/ar_cli_spec.rb
 - spec/sk_sdk/oauth_spec.rb
+- spec/sk_sdk/resources/clients_spec.rb
+- spec/sk_sdk/resources/credit_note_spec.rb
+- spec/sk_sdk/resources/invoice_spec.rb
+- spec/sk_sdk/resources/product_spec.rb
 - spec/sk_sdk/signed_request_spec.rb
 - spec/spec_helper.rb