sk-api 1.1.0 → 1.1.1

data/.gitignore

@@ -2,3 +2,4 @@ nbproject/*
 coverage/*
 rdoc/*
 pkg/*
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.rdoc

@@ -1,241 +1,3 @@
-= SalesKing Api
+= This gem is DEPRECATED & OUTDATED
 
-This gem provides an api client using ActiveResource and also provides the API's JSON-Schema
-In the near future this will be decoupled and you will find links to the new gems here.
-
-The SalesKing API client uses JSON and ActiveResource, with some fixes due to json parsing.
-
-To be able to use the API you must have an SalesKing account and API access. 
-Than you can start writing your own middelware-stack.
-
-== Install
-
-if you try to use it please tell us, so we can provide you a login on our dev system
-and support.
-
-    gem install sk-api
-
-Use with bundler
-
-    gem "sk-api", :require => 'sk_api'
-
-== Usage
-
-SalesKing's api interface is RESTful(mostly) and returns & accepts JSON data.
-All resources such as clients, invoices, products can be accessed via URL's
-through standard HTTP methods GET, POST, PUT and DELETE.
-
-To give it quick shot, point your browser to my-account.salesking.eu/api/clients.json
-(while beeing logged in) and you will see the JSON in the response.
-This is an example of a GET-request issued by your browser.
-
-<b>Request Method overview:</b>
-GET => read
-POST => create new data
-PUT => update data
-DELETE => delete data
-
-Want to know more about REST style webservices?
-* http://en.wikipedia.org/wiki/Representational_State_Transfer
-* http://www.google.com/search?q=REST+site%3Awww.infoq.com
-
-=== Authentification & Safety
-
-Authentification is done with HTTP basic using your SalesKing login email and password.
-For a production environment it is advisable to create a user, per api
-client-software, and restrict his rights with our build in role-system.
-
-=== Toolz
-
-Since browsers do not support PUT/DELETE methods you can use CURL, a linux
-command-line http client, for testing. And of course any http library supporting
-http-basic-auth can be used.
-
-* JSONView  FF-Plugin - view json in firefox https://addons.mozilla.org/de/firefox/addon/10869/
-* JSONovich FF-Plugin -  https://addons.mozilla.org/de/firefox/addon/10122/
-* A java GUI REST client http://code.google.com/p/rest-client/
-
-=== GET / Show data
-
-Get a list of resources:
-    GET xy.salesking.eu/api/invoices
-
-Get a single resource
-    GET xy.salesking.eu/invoices/:id
-
-Using CURL
-
-  curl -u your@login-mail.com:password \
-  https://demo.salesking.eu/clients.json
-
-Returned JSON data for a listings, abbreviated:
-    {
-    "clients": [                    # array of resources => clients
-      { "client": {                 # a single resource
-        "number": "0800013", ..
-        "links":{}                  #links to actions for the resource (comming soon)
-      }, ...
-    ],
-    collection": {                  # information about the collection
-      "total_pages": 1,
-      "total_entries": 3,
-      "current_page": 1,
-      "per_page": 30
-    },
-    "links": {                      # links for the collection
-      "prev": "/api/clients?page=0",
-      "next": "/api/clients?page=2",
-      "self": "/api/clients?page=1"
-      }, 
-    }
-
-==== Filtering
-
-Filtering data can be achived by adding a filter parameter to the url. 
-
-All objects which can be tagged(clients, documents, products) can be filter by a tag param, taking one or multiple tags:
-    GET xy.salesking.eu/api/invoices?filter[tags]=Agentur
-    GET xy.salesking.eu/api/invoices?filter[tags]=Agentur Grafik
-    # find all objects without tags
-    GET xy.salesking.eu/api/invoices?filter[not_tagged]=1
-
-All objects have a q-search available. The fields to be searched in can be seen inside SalesKing, behind the search field above list.
-    GET xy.salesking.eu/api/invoices?q=0800013
-    GET xy.salesking.eu/api/invoices?filter[q]=0800013
-
-Document specific filters
-  # find all documents for a client
-  GET xy.salesking.eu/api/invoices?filter[client]=:client_id
-
-Client filter:
-  # find clients organisation or lastname starting with A
-  GET xy.salesking.eu/api/clients?filter[letter]=A
-
-=== POST / Create data
-
-To create a resource you can use the gem with its methods or make a POST request containing the json for a single resource.
-The JSON format can be seen in each of the resources: http://github.com/salesking/sk-api/tree/master/lib/resources/
-
-  POST https://my-sub.salesking.eu/invoices.json content-type application/json
-
-This a minimal json to create a draft invoice:
-
-  {"invoice": {
-    "due_days": 14,
-    "line_items": [
-      {
-          "quantity_unit": "Stuck",
-          "tax": 19,
-          "price_single": 0,
-          "position": 1,
-          "quantity": 21,
-          "description": "dep38usabq4Boxen kostenlos"
-      },
-      {
-        "quantity_unit": "Stuck",
-        "tax": 19,
-        "price_single": 0.042022,
-        "position": 2,
-        "quantity": 21,
-        "description": "dep38usabq4 Boxen"
-      }
-    ],
-    "title": "Dabei",
-    "client_id": "c5d5xIwZGr3R56abxfpGMl",
-    "address_field": "Wurst Bolle\nHalve-Hahn Alle 4711\n50733 Köln-Nippes"
-  }}
-
-Some quick hints on document creation:
-
-* The line items array does not need prefixes .. (sry little inconsistency here)
-* Dates are formatted like  <tt>yyyy-mm-dd 2010-09-08</tt>
-* <tt>"price_total": 0.88,  "price_tax": 0.167</tt> can be ommited are calculated by sk => read only
-* <tt>due_date</tt> if left out will be auto calculated from due days. If date and due date are given due_days are not taken into consideration.
-* <tt>status: draft</tt> is default, so can be omitted
-* <tt>client_id</tt> must be given as uuid of the client object
-* line items with quantity of 0 are kicked
-* If you create the doc as draft you can leave out any dates. When “opened” in salesking the date will be set and due date is calculated from due_days
-* If you create the invoice as "open" you must set a number(and date), by now there is no api method to get the next number.
-* The proposed workflow is to create the document as draft and continue (open/send/close) in SalesKing.
-
-
-For more information on how to use take a look into the tests/specs:
-
-http://github.com/salesking/sk-api/tree/master/spec/resources/
-
-=== PUT / Update data
-
-To Update a client:
- 
-PUT ( application/json ) to ../api/clients/:id
-  {
-    'client': 
-    { 
-      'gender':'male',
-      'first_name': "Andrew"
-    }
-  }
-
-=== DELETE / kill data
-
-To delete a record simply issue a DELETE request to a resource url:
-
-    DELETE https://demo.salesking.eu/clients/:id
-
-== Ruby Example
-
-Since the sk-api gem provides a wrapper around the whole url/request stuff its
-pretty straight forward to use:
-
-    class SomeMiddleware
-      include SKApi::Resources
-
-      def initialize()
-        # init api connection => just an example depending on your code structure do it wherever you want
-        set_api_connection
-      end
-
-      def create_client(last_name)
-        # create a new client object
-        client = SKApi::Resources::Client.new(:last_name=> last_name)
-        # set more data
-        client.first_name = "Meister"
-        # save it, which also does the remote saving action
-        client.save
-      end
-
-      def set_api_connection
-        SKApi::Resources::Base.set_connection({
-          :site     => 'my_sub.salesking.eu',
-          :user     => 'demo@salesking.eu',
-          :password => 'password',
-          :format   => :json # symbol expected
-        })
-      end
-    end
-
-    ##### use it
-    a = SomeMiddleware.new
-    a.create_client('eder')
-
-
-== Salesking API Resources
-
-Right now the following resources are available:
-
-* clients
-* invoices
-* products
-* credit_notes
-
-See classes here:
-http://github.com/salesking/sk-api/tree/master/lib/resources/
-
-== Tests / Specs
-
-To run the test you must insert some credentials into the spec helper. 
-We will gladly provide you with a test account on one of our development 
-systems.
-
-
-Copyright (c) 2009, 2010 Georg Leciejewski, released under the MIT license
+{Use our new SalesKing-SDK}[https://github.com/salesking/sk_sdk]

data/Rakefile

@@ -1,42 +1,21 @@
-require 'rubygems'
 require 'rake'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'bundler/gem_helper'
+
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "sk-api"
-    gem.summary = %Q{Interact with SalesKing}
-    gem.description = %Q{Interact with SalesKing}
-    gem.email = "gl@salesking.eu"
-    gem.homepage = "http://github.com/salesking/sk-api"
-    gem.authors = ["Georg Leciejewski"]
-    gem.add_development_dependency "rspec", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
 
 desc 'Default: run specs.'
 task :default => :spec
 
-spec_files = Rake::FileList["spec/**/*_spec.rb"]
-
 desc "Run specs"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = spec_files
-  t.spec_opts = ["-c"]
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
 end
 
-desc "Generate code coverage"
-Spec::Rake::SpecTask.new(:coverage) do |t|
-  t.spec_files = spec_files
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
-end
 
 desc 'Generate sk-api documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|

data/lib/patches/README

@@ -1,3 +1,4 @@
-Patches for activerecord as long as the 3.0 version is not out
+Patches for activerecord
 
+* parse nested json responses
 * parse error from json response

data/lib/patches/ar2/base.rb

@@ -22,7 +22,9 @@ module ActiveResource
 
     # override ARes method to parse only the client part
     def load_attributes_from_response(response)
-      if response['Content-Length'] != "0" && response.body.strip.size > 0
+      if (response['Transfer-Encoding'] == 'chunked' ||
+          (!response['Content-Length'].blank? && response['Content-Length'] != "0")) &&
+          !response.body.nil? && response.body.strip.size > 0
         load( self.class.format.decode(response.body)[self.class.element_name] )
       end
     end

data/lib/patches/ar3/base.rb

@@ -5,8 +5,11 @@ module ActiveResource
 
     # override ARes method to parse only the client part
     def load_attributes_from_response(response)
-      if response['Content-Length'] != "0" && response.body.strip.size > 0
+      if (response['Transfer-Encoding'] == 'chunked' ||
+          (!response['Content-Length'].blank? && response['Content-Length'] != "0")) &&
+          !response.body.nil? && response.body.strip.size > 0
         load( self.class.format.decode(response.body)[self.class.element_name] )
+        @persisted = true
       end
     end
 

data/lib/resources/base.rb

@@ -4,12 +4,19 @@ module SKApi
     class Base < ActiveResource::Base
       include SKApi::Utils::Serializer
       self.format = :json # bug in AR must be set here
-      
-      def initialize(attributes = {})
-        # json comes in nested {client={data}
-        attr = attributes[self.class.element_name] || attributes
-        super(attr)
-      end
+      # hook before init in activeresource base because json comes in nested:
+        # {client={data}
+        if ActiveResource::VERSION::MAJOR == 3 && ActiveResource::VERSION::MINOR > 0
+          def initialize(attributes = {}, *args)
+            attr = attributes[self.class.element_name] || attributes
+            super(attr, *args)
+          end
+        else
+          def initialize(attributes = {})
+            attr = attributes[self.class.element_name] || attributes
+            super(attr)
+          end
+        end
 
       # Define the connection to be used when talking to a salesking server
       def self.set_connection(opts)

data/lib/resources/invoice.rb

@@ -6,19 +6,6 @@ module SKApi
         save_with_validation
       end
 
-      def open
-        self.put(:open, :id => self.id)  # PUT /invoices/:id/open
-      end
-
-      # rethink
-      def print(template_id)
-        self.get(:print, :template_id => template_id)  # GET /invoices.pdf?template_id=:ids
-      end
-
-      def mail(template_id, cc, bcc)
-        self.get(:print, :template_id => template_id)  # GET /invoices.pdf?template_id=:ids
-      end
-
       ##########################################################################
       # Class methods
       ##########################################################################
@@ -54,14 +41,8 @@ module SKApi
 
       def self.api_links
         #internal links on fields=> id => salesking.eu/clients/4567.json
+      #external links to actions and related objects => invoeis => salesking.eu/clients/4567/invoices.json
         [:edit, :destroy, :copy, :print, :show, :payments, :payment_new]
-#        [ :edit,
-#          :destroy,
-#          { :copy =>"invoices/new?source=#{self.id}" },
-#            :open => "PUT invoices/#{self.id}/open",
-#            :print,
-#            :show, ]
-
       end
     end
   end

data/lib/sk_api.rb

@@ -23,6 +23,4 @@ require 'resources/client'
 require 'resources/address'
 require 'resources/invoice'
 require 'resources/credit_note'
-require 'resources/line_item'
-
-# TODO before post kick empty fields and readonly's
+require 'resources/line_item'

data/lib/version.rb

@@ -0,0 +1,3 @@
+module SKApi
+  VERSION = "1.1.1"
+end

data/sk-api.gemspec

@@ -1,12 +1,9 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
-
+$:.push File.expand_path('../lib', __FILE__)
+require 'version'
 Gem::Specification.new do |s|
   s.name = %q{sk-api}
-  s.version = "1.1.0"
-
+  s.version = SKApi::VERSION
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
   s.date = %q{2010-11-07}
@@ -15,68 +12,23 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
-  s.files = [
-    ".gitignore",
-     "MIT-LICENSE",
-     "Manifest",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/patches/README",
-     "lib/patches/ar2/base.rb",
-     "lib/patches/ar2/validations.rb",
-     "lib/patches/ar3/base.rb",
-     "lib/patches/ar3/validations.rb",
-     "lib/resources/address.rb",
-     "lib/resources/base.rb",
-     "lib/resources/client.rb",
-     "lib/resources/credit_note.rb",
-     "lib/resources/invoice.rb",
-     "lib/resources/line_item.rb",
-     "lib/resources/product.rb",
-     "lib/sk_api.rb",
-     "lib/utils/field_map.rb",
-     "lib/utils/serializer.rb",
-     "sk-api.gemspec",
-     "spec/resources/client_spec.rb",
-     "spec/resources/credit_note_spec.rb",
-     "spec/resources/invoice_spec.rb",
-     "spec/resources/product_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/utils/field_map_spec.rb",
-     "tasks/sk_api_tasks.rake",
-     "vendor/jsonschema-1.0.0/README.rdoc",
-     "vendor/jsonschema-1.0.0/Rakefile",
-     "vendor/jsonschema-1.0.0/lib/jsonschema.rb",
-     "vendor/jsonschema-1.0.0/ruby-jsonschema.gemspec",
-     "vendor/jsonschema-1.0.0/test/jsonschema_test.rb"
-  ]
+
   s.homepage = %q{http://github.com/salesking/sk-api}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Interact with SalesKing}
-  s.test_files = [
-    "spec/resources/client_spec.rb",
-     "spec/resources/credit_note_spec.rb",
-     "spec/resources/invoice_spec.rb",
-     "spec/resources/product_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/utils/field_map_spec.rb"
-  ]
+  s.executables   = nil
+  s.files         = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end
+  s.add_runtime_dependency 'activeresource', '< 3'
 
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'xml-simple'
+  s.add_development_dependency 'rake', '>= 0.9.2'
+end