theyoweme 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+= Nibbme - Changelog
+
+
+== TheyOweMe v0.1.0 released 2010/09/07
+
+* initial release
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Kristijan Sedlak]
+
+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.rdoc

@@ -0,0 +1,153 @@
+= TheyOweMe - your personal note book for tracking debts and loans!
+
+The library is a simple {ActiveResource}[http://api.rubyonrails.org/classes/ActiveResource/Base.html]-based 
+proxy that allows you to communicate with the {TheyOweMe web service}[http://theyowe.me]. 
+{TheyOweMe}[http://theyowe.me] is a restful-designed system and you can easily 
+{create your own plugin/gem}[http://theyowe.me/wiki] based on the Wiki they provide. 
+If you like plugins and gems read on :).
+
+
+== Installation
+
+The recommended way is to install a gem. Simply execute
+
+  gem install theyoweme
+
+and the latest package will be installed. If you use Rails with bundler add 
+
+  gem theyoweme
+
+to your Rails project's Gemfile file and then execute a "bundle install" command. 
+If you do not use bundler you will add 
+
+  config.gem 'theyoweme'
+
+to your Rails project's {RAILS_ROOT}/config/environment.rb file.
+
+
+== Configuration
+
+You've successfully installed the TheyOweMe gem and it's time to configure it.
+From your rails project's root execute
+
+  theyowemerize .
+
+This will create a configuration file theyoweme.yml inside your {RAILS_ROOT}/config 
+directory. Open it and set your TheyOweMe account information. The file should look 
+something like
+
+  default: &defaults
+    email: john@smith.com
+    password: secret
+
+  development:
+    <<: *defaults
+
+  test:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+  
+If you do not already have a TheyOweMe account then {sign up}[http://theyowe.me/sign_up] now.
+
+That's it! You are ready to rock&role.  
+
+
+== Examples
+
+You will use this library like you use any other {ActiveResource}[http://api.rubyonrails.org/classes/ActiveResource/Base.html] 
+classes. 
+
+
+=== Managing contacts
+
+You can request data simply by calling a +find+ method.
+
+  contacts = TheyOweMe::Contact.find(:all) 
+  contacts = TheyOweMe::Contact.find(:first) 
+  contacts = TheyOweMe::Contact.find(:last) 
+  contact  = TheyOweMe::Contact.find(15) # Where 15 is a Contact ID number
+
+Note that this will return only the items on the first page. You can pass the +page+ variable to
+get the items on the subpage. If the request is empty you know there are no more items.
+
+  # Request the second page
+  contacts = TheyOweMe::Contact.find(:all, :params => { :page => 1 })
+
+You can also filter the list through a +tags+ variable.
+
+  # Request the second page but filter only the items containing the word 'john'
+  contacts = TheyOweMe::Contact.find(:all, :params => { :page => 1, :tags => 'john' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the contact with ID=1 exists
+  exists = TheyOweMe::Contact.exists?(1)
+
+You can also create, update and delete contacts.
+
+  # Create an empty contact
+  contact = TheyOweMe::Contact.create
+
+  # Create a contact with all information
+  contact = TheyOweMe::Contact.create(:full_name => 'John Smith', :gender => 'M', :email => 'john@gmail.com', :country_code => 44, :phone_number => 31321551)
+
+  # Update a contact with ID=15
+  contact = TheyOweMe::Contact.find(15)
+  contact.email = 'john@smith.com'
+  contact.save
+
+  # Destroy a contact with ID=12
+  contact = TheyOweMe::Contact.find(12)
+  contact.destroy
+
+
+=== Managing debts
+
+You can request data simply by calling a +find+ method.
+
+  debts = TheyOweMe::Debt.find(:all) 
+  debts = TheyOweMe::Debt.find(:first) 
+  debts = TheyOweMe::Debt.find(:last) 
+  debt  = TheyOweMe::Debt.find(15) # Where 15 is a Debt ID number
+
+Note that this will return only the items on the first page. You can pass the +page+ variable to
+get the items on the subpage. If the request is empty you know there are no more items.
+
+  # Request the second page
+  debts = TheyOweMe::Debt.find(:all, :params => { :page => 1 })
+
+You can also filter the list through a +tags+ variable.
+
+  # Request the second page but filter only the items containing the word 'john'
+  debts = TheyOweMe::Debt.find(:all, :params => { :page => 1, :tags => 'john' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the debt with ID=1 exists
+  exists = TheyOweMe::Debt.exists?(1)
+
+You can also create, update and delete debts.
+
+  # Create an empty debt
+  debt = TheyOweMe::Debt.create
+
+  # Create a debt with all information
+  debt = TheyOweMe::Debt.create(:title => 'Mandy lunch at BestFood House', :description => 'She did not have money.', :contact_ids => [2], :email_notifications => true)
+
+  # Update a debt with ID=15
+  debt = TheyOweMe::Debt.find(15)
+  debt.description = nil
+  debt.save
+
+  # Destroy a debt with ID=12
+  debt = TheyOweMe::Debt.find(12)
+  debt.destroy
+
+
+== Links
+
+* Detailed information about the TheyOweMe web service is available on {the official TheyOweMe site}[http://theyowe.me].
+* All the latest TheyOweMe news and tutorials are available on {the official TheyOweMe blog site}[http://blog.theyowe.me].
+* You can find more about TheyOweMe integration on {the TheyOweMe WikiBook}[http://theyowe.me/wiki].

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the theyoweme plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the theyoweme plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Theyoweme'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/theyowemerize

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+# This file is based heavily on Capistrano's `capify` command
+
+require 'optparse'
+require 'fileutils'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to theyowemerize, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to theyowemerize."
+end
+
+
+content = <<-FILE
+# Use this file to setup your TheyOweMe communication.
+# Find more information at http://theyowe.me/wiki.
+
+default: &defaults
+  email: 
+  password: 
+  
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+  
+production:
+  <<: *defaults
+ 
+# Learn more: http://github.com/xpepermint/theyoweme
+FILE
+
+file = 'config/theyoweme.yml'
+base = ARGV.shift
+
+file = File.join(base, file)
+if File.exists?(file)
+  warn "[skip] `#{file}' already exists"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(content) }
+end
+
+puts "[done] theyowemerized!"

data/config/theyoweme.yml

@@ -0,0 +1,11 @@
+default: &defaults
+  site: 'http://theyowe.me'
+  
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+  
+production:
+  <<: *defaults

data/lib/theyoweme.rb

@@ -0,0 +1,25 @@
+module TheyOweMe
+  class Tools
+    class << self
+      
+      def config
+        df = File.join(File.dirname(__FILE__), '..', 'config', 'theyoweme.yml')
+        cf = File.join(RAILS_ROOT, 'config', 'theyoweme.yml')
+        config = YAML.load_file(df)[RAILS_ENV]
+        config = config.merge!(YAML.load_file(cf)[RAILS_ENV]) if File.exists?(cf) && YAML.load_file(cf) && YAML.load_file(cf)[RAILS_ENV]
+        config
+      end
+      
+    end
+  end
+end
+
+THEYOWEME_CONFIG = TheyOweMe::Tools.config
+
+%w( theyoweme/version
+    theyoweme/global_resource
+    theyoweme/contact
+    theyoweme/debt
+).each do |lib|
+    require File.join(File.dirname(__FILE__), lib)
+end

data/lib/theyoweme/contact.rb

@@ -0,0 +1,4 @@
+module TheyOweMe
+  class Contact < TheyOweMe::GlobalResource
+  end
+end

data/lib/theyoweme/debt.rb

@@ -0,0 +1,4 @@
+module TheyOweMe
+  class Debt < TheyOweMe::GlobalResource
+  end
+end

data/lib/theyoweme/global_resource.rb

@@ -0,0 +1,10 @@
+module TheyOweMe
+  class GlobalResource < ActiveResource::Base
+
+    self.site = THEYOWEME_CONFIG['site']
+    self.user = THEYOWEME_CONFIG['email']
+    self.password = THEYOWEME_CONFIG['password']
+    self.format = :xml
+
+  end
+end

data/lib/theyoweme/version.rb

@@ -0,0 +1,9 @@
+module TheyOweMe
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

data/test/theyoweme_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class TheyowemeTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: theyoweme
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristijan Sedlak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-07 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: TheyOweMe allows you to easily store information about things your friends or business partners have borrowed from you or things you owe them. The service is the perfect debts tracking and management solution with the ability to notify debtors through email, SMS or regular post.
+email: xpepermint@gmail.com
+executables: 
+- theyowemerize
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+files: 
+- Rakefile
+- bin/theyowemerize
+- lib/theyoweme/contact.rb
+- lib/theyoweme/debt.rb
+- lib/theyoweme/global_resource.rb
+- lib/theyoweme/version.rb
+- lib/theyoweme.rb
+- test/test_helper.rb
+- test/theyoweme_test.rb
+- config/theyoweme.yml
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://github.com/xpepermint/theyoweme
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: TheyOweMe - your personal note book for tracking debts and loans.
+test_files: []
+