billomat-rb 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+.idea
+*.gem
+pkg
+doc
+.DS_Store
+debug.rb
+*~
+*.sw?
+coverage
+pkg
+.rdoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ronald Becher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,21 @@
+h1. billomat-rb
+
+A neat ruby library for interacting with the "RESTful API":http://www.billomat.com/api/ of "billomat":http://www.billomat.com/.
+
+h2. Requirements
+
+billomat-rb requires active_resource and active_support in version 2.3.2 or above.
+
+h2. Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2010 Ronald Becher. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+task :default => [:build]
+
+$gem_name = "billomat-rb"
+ 
+#desc "Run specs"
+#task :spec do
+#  sh "spec spec/* --format specdoc --color"
+#end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "billomat-rb"
+    gem.summary = "Ruby library for interacting with the RESTfull billomat api."
+    gem.description = "A neat ruby library for interacting with the RESTfull API of billomat"
+    gem.email = "rb@ronald-becher.com"
+    gem.homepage = "http://github.com/rbecher/billomat-rb"
+    gem.authors = ["Ronald Becher"]
+    gem.rubyforge_project = "billomat-rb"
+    gem.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    gem.add_dependency(%q<activeresource>, [">= 2.3.2"])
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "billomat-rb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.textile

@@ -0,0 +1,28 @@
+h1. STD (Still To Do)
+
+h2. General
+* General framework
+* Formats
+** XML
+** JSON
+* Authentification
+* Distinguish read-only and read-write resources
+* Error handling
+* SSL and not SSL (or even exclusively?)
+
+h2. Resources
+* Customer
+* Articles
+* Units
+* Bills
+** Bill-Items
+** Bill-Comments
+** BIll-History
+** Payments
+* Offers
+** Offer-Items
+** Offer-Comments
+** Offer-History
+* Templates
+* Settinfs
+* User

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:build: 
+:patch: 1
+:major: 0
+:minor: 0

data/billomat-rb.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{billomat-rb}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ronald Becher"]
+  s.date = %q{2010-03-30}
+  s.description = %q{A neat ruby library for interacting with the RESTfull API of billomat}
+  s.email = %q{rb@ronald-becher.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "TODO.textile",
+     "VERSION.yml",
+     "billomat-rb.gemspec",
+     "lib/billomat-rb.rb",
+     "lib/billomat/account.rb",
+     "lib/billomat/myself.rb",
+     "lib/billomat/settings.rb",
+     "lib/billomat/users.rb"
+  ]
+  s.homepage = %q{http://github.com/rbecher/billomat-rb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{billomat-rb}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby library for interacting with the RESTfull billomat api.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_runtime_dependency(%q<activeresource>, [">= 2.3.2"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_dependency(%q<activeresource>, [">= 2.3.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<activeresource>, [">= 2.3.2"])
+  end
+end
+

data/lib/billomat-rb.rb

@@ -0,0 +1,171 @@
+require 'rubygems'
+gem 'activeresource', '=2.3.5'
+gem 'activesupport', '=2.3.5'
+require 'active_support'
+require 'active_resource'
+
+# A neat ruby library for interacting with the RESTfull API of billomat
+
+module Billomat
+
+  class << self
+    attr_accessor :email, :password, :host_format, :domain_format, :protocol, :port, :api_path
+    attr_reader :account, :key
+
+    # Sets the account name and updates all resources with the new domain
+    def account=(name)
+      resources.each do |klass|
+        klass.site = klass.site_format % (host_format % [protocol, domain_format % name, ":#{port}", api_path])
+      end
+      @account = name
+    end
+
+    # Sets up basic authentication credentials for all resources.
+    # Removes all earlier authentication info
+    def authenticate (email,password)
+      resources.each do |klass|
+        klass.email = email
+        klass.password = password
+        klass.headers.delete 'X-BillomatApiKey'
+      end
+      @email = email
+      @password = password
+      @key = nil
+    end
+
+    # Sets the api key for all resource
+    # Removes all earlier authentication info
+    def key=(value)
+      resources.each do |klass|       
+        klass.headers['X-BillomatApiKey'] = value
+      end
+      @key = value
+      @email = nil
+      @password = nil
+    end
+
+    # Validates connection
+    # returns true when valid false when not
+    def validate
+      validate! rescue false
+    end
+
+    # Same as validate
+    # but raises http-error when connection is invalid
+    def validate!
+      !!Billomat::Myself.find
+    end
+
+    def resources
+      @resources ||= []
+    end
+  end
+
+  self.host_format   = '%s://%s%s%s' # protocol :// domain_format port path
+  self.domain_format = '%s.billomat.net'
+  self.api_path      = '/api'
+  self.protocol      = 'http'
+  self.port          = '80'
+
+  class MethodNotAvailable < StandardError; end
+
+  module ResourceWithoutWriteAccess
+    def save
+      raise MethodNotAvailable, "Cannot save #{self.class.name} over billomat api"
+    end
+
+    def create
+      raise MethodNotAvailable, "Cannot save #{self.class.name} over billomat api"
+    end
+
+    def destroy
+      raise MethodNotAvailable, "Cannot save #{self.class.name} over billomat api"
+    end
+  end
+
+  # possibly ResourceWithActiveArchived
+
+  class Base < ActiveResource::Base
+    class << self
+      def inherited(base)
+        unless base == Billomat::SingletonBase
+          Billomat.resources << base
+          class << base
+            attr_accessor :site_format
+          end
+          base.site_format = '%s'
+          base.timeout = 20
+        end
+        super
+      end
+
+      def element_path(id,prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+      end
+
+      def collection_path(prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+      end
+
+      # Some common shortcuts from ActiveRecord
+
+      def all(options={})
+        find(:all,options)
+      end
+
+      def first(options={})
+        find_every(options).first
+      end
+
+      def last(options={})
+        find_every(options).last
+      end
+    end
+
+    private
+
+    def query_string?(options)
+      options.is_a?(String) ? "#{options}" : super
+    end
+  end
+
+  class SingletonBase < Base
+    include ResourceWithoutWriteAccess
+
+    class << self
+      def collection_name
+        element_name
+      end
+    end
+
+    def find
+      super(1)
+    end
+
+    def self.first
+      self.find
+    end
+
+    def self.last
+      self.find
+    end
+
+    alias_method :first, :find
+    alias_method :last, :find
+
+    # Prevent collection methods
+    def self.all
+      raise MethodNotAvailable, "Method not supported on #{self.class.name}"
+    end
+  end
+end
+
+#$:.unshift(File.dirname(__FILE__))
+#Dir[File.join(File.dirname(__FILE__), "billomat/*.rb")].each { |f| require f }
+
+require File.dirname(__FILE__) + '/billomat/account'
+require File.dirname(__FILE__) + '/billomat/settings'
+require File.dirname(__FILE__) + '/billomat/users'
+require File.dirname(__FILE__) + '/billomat/myself'

data/lib/billomat/account.rb

@@ -0,0 +1,2 @@
+class Billomat::Account < Billomat::SingletonBase
+end

data/lib/billomat/myself.rb

@@ -0,0 +1,15 @@
+class Billomat::Myself < Billomat::SingletonBase
+
+  # non standard path
+  def self.element_name
+    "users/myself"
+  end
+
+  # get the billomat user for the logged in person
+  def user
+    Billomat::Users.all.each do |user|
+      return user if user.id==self.id
+    end
+    raise StandardError
+  end
+end

data/lib/billomat/settings.rb

@@ -0,0 +1,2 @@
+class Billomat::Settings < Billomat::SingletonBase
+end

data/lib/billomat/users.rb

@@ -0,0 +1,3 @@
+class Billomat::Users < Billomat::Base
+  include Billomat::ResourceWithoutWriteAccess
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: billomat-rb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ronald Becher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id002
+description: A neat ruby library for interacting with the RESTfull API of billomat
+email: rb@ronald-becher.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- TODO.textile
+- VERSION.yml
+- billomat-rb.gemspec
+- lib/billomat-rb.rb
+- lib/billomat/account.rb
+- lib/billomat/myself.rb
+- lib/billomat/settings.rb
+- lib/billomat/users.rb
+has_rdoc: true
+homepage: http://github.com/rbecher/billomat-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: billomat-rb
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby library for interacting with the RESTfull billomat api.
+test_files: []
+