nibbme 1.0.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 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,208 @@
+= Nibbme - SMS web service proxy
+
+The library is a simple {ActiveResource}[http://api.rubyonrails.org/classes/ActiveResource/Base.html]-based 
+proxy that allows you to communicate with the {Nibbme bulk SMS web service}[http://www.nibbme.com]. 
+{Nibbme}[http://www.nibbme.com] is a restfull-designed sistem and you can easily {create your own plugin/gem}[http://www.nibbme.com/wiki]
+based on the Wiki they provide. If you like plugins and gems read on :).
+
+
+== Installation
+
+The recommended way is to install a gem:
+
+  gem install nibbme
+
+Add this line to your rails project's {RAILS_ROOT}/config/environment.rb:
+
+  config.gem 'nibbme'
+
+Because Rails can't load rake tasks from gems open {RAILS_ROOT}/Rakefile and add this:
+
+  begin
+    require 'nibbme/tasks'
+  rescue LoadError
+    STDERR.puts "Run `rake gems:install` to install nibbme"
+  end
+
+Open the console and redirect it to your project's root and run the install task:
+
+  $ rake nibbme:install 
+
+The task creates a configuration file inside your {RAILS_ROOT}/config directory. Now 
+open this file and set variables. The file should look something like this:
+
+  # Nibbme configuration file
+
+  default: &defaults
+    site: 'https://www.nibbme.com'
+    email: 
+    password: 
+  
+  development:
+    <<: *defaults
+
+  test:
+    <<: *defaults
+  
+  production:
+    <<: *defaults
+  
+That's it! You are ready to rock & role.  
+
+
+== Example usage
+
+You will use this library like you use any other {ActiveResource}[http://api.rubyonrails.org/classes/ActiveResource/Base.html] 
+classes. 
+
+=== Groups
+
+You can request data simply by calling a +find+ method.
+
+  groups = Nibbme::Group.find(:all) 
+  groups = Nibbme::Group.find(:first) 
+  groups = Nibbme::Group.find(:last) 
+
+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 is no more items.
+
+  # Request the second page
+  groups = Nibbme::Group.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 words 'sun' and 'fun'
+  groups = Nibbme::Group.find(:all, :params => { :page => 1, :tags => 'sun fun' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the group with ID=1 exists
+  exists = Nibbme::Group.exists?(1)
+
+You can also create, update and destroy groups.
+
+  # Create an empty group
+  group = Nibbme::Group.create
+
+  # Create a group with title and destription
+  group = Nibbme::Group.create(:title => 'School friends', :description => 'All my friends from the school in US.')
+
+  # Update a group with ID=15
+  group = Nibbme::Group.find(15)
+  group.title = 'Nibbme Members'
+  group.save
+  
+  # Destroy a group with ID=12
+  group = Nibbme::Group.find(12)
+  group.destroy
+
+=== Clients
+
+You can request data simply by calling a +find+ method.
+
+  clients = Nibbme::Client.find(:all) 
+  clients = Nibbme::Client.find(:first) 
+  clients = Nibbme::Client.find(:last) 
+
+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 is no more items.
+
+  # Request the second page
+  clients = Nibbme::Client.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'
+  clients = Nibbme::Client.find(:all, :params => { :page => 1, :tags => 'john' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the client with ID=1 exists
+  exists = Nibbme::Client.exists?(1)
+
+You can also create, update and destroy clients.
+
+  # Create an empty client
+  client = Nibbme::Client.create
+
+  # Create a client with all information
+  client = Nibbme::Client.create(:cell_phone => '99999999', :country_id => 44, :name => 'John', :surname => 'Hill', :group_ids => '22,41,512')
+
+  # Update a client with ID=15
+  client = Nibbme::Client.find(15)
+  client.country_id = 44
+  client.save
+
+  # Destroy a client with ID=12
+  client = Nibbme::Client.find(12)
+  client.destroy
+
+=== Messages
+
+You can request data simply by calling a +find+ method.
+
+  messages = Nibbme::Message.find(:all) 
+  messages = Nibbme::Message.find(:first) 
+  messages = Nibbme::Message.find(:last) 
+
+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 is no more items.
+
+  # Request the second page
+  messages = Nibbme::Message.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'
+  messages = Nibbme::Message.find(:all, :params => { :page => 1, :tags => 'john' })
+
+You can check if an item exists by calling the +exists?+ method.
+
+  # Check if the message with ID=1 exists
+  exists = Nibbme::Message.exists?(1)
+
+You can also create, update and destroy messages.
+
+  # Create an empty message
+  message = Nibbme::Message.create
+
+  # Create a message with a full info
+  message = Nibbme::Message.create(:text => 'This is my SMS message.', :active_from => 3.hours.from_now, :group_ids => '21,44,5')
+
+  # Update a message with ID=15
+  message = Nibbme::Message.find(15)
+  message.text = 'Nibbme is rocks!'
+  message.save
+
+  # Destroy a message with ID=12
+  message = Nibbme::Message.find(12)
+  message.destroy
+
+You can queue a message by calling a +queue+ method.
+
+  # Queue a message with ID=12
+  message = Nibbme::Message.find(12)
+  message.queue
+
+You can reset/restart the delivery process by calling a +reset+ method.
+
+  # Reset delivery process for a message with ID=12
+  message = Nibbme::Message.find(12)
+  message.reset
+
+=== Error Handling
+
+Similar to ActiveRecord all errors are logged as part of +errors+ variable.
+
+  # Producing an error on the cell_phone field
+  message = Message.create(:cell_phone => 'aaaaa')
+  message.errors[:cell_phone]
+
+You can find more about error handling {here}[http://api.rubyonrails.org/classes/ActiveResource/Validations.html].
+
+
+== Links
+
+* Detailed information about the Nibbme web service are available on {the official Nibbme site}[http://www.nibbme.com].
+* All the latest Nibbme news and tutorials are available on {the official Nibbme blog site}[http://blog.nibbme.com].
+* You can find more about Nibbme integration on {the Nibbme WikiBook}[http://www.nibbme.com/wiki].

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the nibbme 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 nibbme plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nibbme'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config/nibbme.yml

@@ -0,0 +1,13 @@
+default: &defaults
+  site: 'http://www.nibbme.com'
+  email: 
+  password: 
+  
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+  
+production:
+  <<: *defaults

data/lib/nibbme.rb

@@ -0,0 +1,26 @@
+module Nibbme
+  class Tools
+    class << self
+      
+      def config
+        df = File.join(File.dirname(__FILE__), '..', 'config', 'nibbme.yml')
+        cf = File.join(RAILS_ROOT, 'config', 'nibbme.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
+
+NIBBME_CONFIG = Nibbme::Tools.config
+
+%w( nibbme/version
+    nibbme/abstract_base
+    nibbme/client
+    nibbme/group
+    nibbme/message
+).each do |lib|
+    require File.join(File.dirname(__FILE__), lib)
+end

data/lib/nibbme/abstract_base.rb

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

data/lib/nibbme/client.rb

@@ -0,0 +1,4 @@
+module Nibbme
+  class Client < Nibbme::AbstractBase
+  end
+end

data/lib/nibbme/group.rb

@@ -0,0 +1,4 @@
+module Nibbme
+  class Group < Nibbme::AbstractBase
+  end
+end

data/lib/nibbme/message.rb

@@ -0,0 +1,19 @@
+module Nibbme
+  class Message < Nibbme::AbstractBase
+    
+    def queue
+      self.put(:queue)
+      true
+    rescue
+      false
+    end
+
+    def reset
+      self.put(:reset)
+      true
+    rescue
+      false
+    end
+    
+  end
+end

data/lib/nibbme/tasks.rb

@@ -0,0 +1,25 @@
+namespace :nibbme do
+  
+  desc "Install Nibbme plugin"
+  task :install do
+    path = File.join(RAILS_ROOT, 'config', 'nibbme.yml')
+    if !File.exists?(path)
+      f = File.new(path, "w")
+      f.puts("# Nibbme configuration file")
+      f.puts("#")
+      f.puts("# development:")
+      f.puts("#   <<: *defaults")
+      f.puts("#")
+      f.puts("# test:")
+      f.puts("#   <<: *defaults")
+      f.puts("#")
+      f.puts("# production:")
+      f.puts("#   <<: *defaults")
+      f.close
+      puts "   Create config/nibbme.yml"
+    else
+      puts "   Exists config/nibbme.yml"
+    end
+  end
+  
+end

data/lib/nibbme/version.rb

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

data/test/nibbme_test.rb

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

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: nibbme
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kristijan Sedlak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: The nibbme library provides a simple and powerful API for communicationg with the Nibbme SMS web service at www.nibbme.com.
+email: xpepermint@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+files: 
+- Rakefile
+- lib/nibbme/abstract_base.rb
+- lib/nibbme/client.rb
+- lib/nibbme/group.rb
+- lib/nibbme/message.rb
+- lib/nibbme/tasks.rb
+- lib/nibbme/version.rb
+- lib/nibbme.rb
+- test/nibbme_test.rb
+- test/test_helper.rb
+- config/nibbme.yml
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://github.com/xpepermint/nibbme
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Nibbme bulk SMS plugin for web frameworks and other applications
+test_files: []
+