ychaker-zeep_it 0.0.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Youssef Chaker
+
+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,65 @@
+= ZeepIt
+
+ZeepIt is a plugin that leverages the zeep-messaging gem to create the models/controllers/views required to get your app ready to use the Zeep Mobile SMS service. 
+
+All you need to do is install the plugin, run the setup and sign up for an account at http://zeepmobile.com. Then make sure that your callback URL in your Zeep Mobile account point to http://www.yourdomain.com/zeep_sms/incoming and you add your api_key and you secret_key to config/zeep_it.yml and you'll be good to go.
+
+
+== Prerequisites
+
+A Zeep Mobile (http://zeepmobile.com) account and the respective API and SECRET keys.
+
+
+== Install
+
+Install from gihub:
+	gem sources -a http://gems.github.com
+	sudo gem install ychaker-zeep_it
+	
+you only have to update your gem sources once
+
+== Setup
+
+From your Rails App root directory run:
+	
+	rake zeep_it:setup
+	
+(make sure your db is already created!)
+
+Then edit config/zeep_it.yml with the correct API and SECRET keys. 
+
+
+== Examples
+
+Example of using the helper method for displaying the Zeep Mobile:
+
+	<%= zeep_form(user_id) %>
+	
+Example of sending an SMSL
+
+	ZeepSms::send_sms('user_id', 'body of SMS')
+
+Example of creating a ZeepSms and sending it:
+
+	sms = ZeepSms.new(:login=> 'user_id', :raw =>'body of SMS')
+	sms.send_text
+
+Examples of parsing an SMS:
+
+	sms = ZeepSms.new(:login=> 'user_id', :raw =>'body of SMS')
+	sms.parse_for(:keyword => 'user:') 
+		#=> returns the text found after the keywork and before the next space
+	sms.parse_for(:pattern => /[0-9]/) 
+		#=> returns the text found after the first digit and before the next space
+	sms.parse_for(:common => 'twitter')
+		#=> returns the text found after the first '@' and before the next space
+	sms.parse_for({:common => 'bang'}, true)
+		#=> returns the text found between the previous space and the next space
+		#=> removing the '!' in between
+
+Also returns the rest of the SMS omitting the 5-8 code in the beginning
+
+
+== Copyright
+
+Copyright (c) 2009 Youssef Chaker, released under the MIT license

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the zeep_it 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 zeep_it plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ZeepIt'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[ 
+  '[a-zA-Z]*', 
+  'generators/**/*', 
+  'lib/**/*', 
+  'rails/**/*', 
+  'tasks/**/*', 
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "zeep_it"
+  s.version = "0.0.4"
+  s.author = "Youssef Chaker"
+  s.email = "youssefchaker@youhhoo.com"
+  s.homepage = "http://github.com/ychaker/zeep_it"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Get your app Zeep Mobile ready"
+  s.description = "Get your app Zeep Mobile ready"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end 

data/generators/zeep_it_route/zeep_it_route_generator.rb

@@ -0,0 +1,7 @@
+class ZeepItRouteGenerator < Rails::Generator::Base #:nodoc:
+  def manifest #:nodoc:
+    record do |m|
+      m.zeep_it_route
+    end
+  end
+end 

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/controllers/zeep_sms_controller.rb

@@ -0,0 +1,104 @@
+class ZeepSmsController < ApplicationController
+
+  # GET /zeep_sms
+  # GET /zeep_sms.xml
+  def index
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @sms }
+    end
+  end
+  
+  # GET /zeep_sms/incoming
+  # GET /zeep_sms/incoming.xml
+  #
+  # Callback URL
+  # When users send SMS messages to your website, Zeep Mobile send the requests to this URL.
+  # I.e. http://example.com/zeep_sms/incoming
+  def incoming    
+    response.headers["Content-Type"] = "text/plain; charset=utf-8"
+    #Read params from the text message
+    
+    if (params[:uid] && params[:body])
+      @userid = params[:uid]
+      @body = params[:body]    
+      sms = ZeepSms.new(:raw => @body, :login => @userid)
+    end
+  
+  end
+  
+  # CRUD method templates:
+  
+  # GET /zeep_sms/1
+  # GET /zeep_sms/1.xml
+  # def show
+  #   @sms = ZeepSms.find(params[:id])
+  # 
+  #   respond_to do |format|
+  #     format.html # show.html.erb
+  #     format.xml  { render :xml => @sms }
+  #   end
+  # end
+
+  # GET /zeep_sms/new
+  # GET /zeep_sms/new.xml
+  # def new
+  #   @sms = ZeepSms.new
+  # 
+  #   respond_to do |format|
+  #     format.html # new.html.erb
+  #     format.xml  { render :xml => @sms }
+  #   end
+  # end
+
+  # GET /zeep_sms/1/edit
+  # def edit
+  #   @sms = ZeepSms.find(params[:id])
+  # end
+
+  # POST /zeep_sms
+  # POST /zeep_sms.xml
+  # def create
+  #   @sms = ZeepSms.new(params[:sms])
+  # 
+  #   respond_to do |format|
+  #     if @sms.save
+  #       flash[:notice] = 'Sms was successfully created.'
+  #       format.html { redirect_to(@sms) }
+  #       format.xml  { render :xml => @sms, :status => :created, :location => @sms }
+  #     else
+  #       format.html { render :action => "new" }
+  #       format.xml  { render :xml => @sms.errors, :status => :unprocessable_entity }
+  #     end
+  #   end
+  # end
+
+  # PUT /zeep_sms/1
+  # PUT /zeep_sms/1.xml
+  # def update
+  #   @sms = ZeepSms.find(params[:id])
+  # 
+  #   respond_to do |format|
+  #     if @sms.update_attributes(params[:sms])
+  #       flash[:notice] = 'Sms was successfully updated.'
+  #       format.html { redirect_to(@sms) }
+  #       format.xml  { head :ok }
+  #     else
+  #       format.html { render :action => "edit" }
+  #       format.xml  { render :xml => @sms.errors, :status => :unprocessable_entity }
+  #     end
+  #   end
+  # end
+
+  # DELETE /zeep_sms/1
+  # DELETE /zeep_sms/1.xml
+  # def destroy
+  #   @sms = ZeepSms.find(params[:id])
+  #   @sms.destroy
+  # 
+  #   respond_to do |format|
+  #     format.html { redirect_to(sms_url) }
+  #     format.xml  { head :ok }
+  #   end
+  # end
+end

data/lib/app/helpers/zeep_sms_helper.rb

@@ -0,0 +1,11 @@
+module ZeepSmsHelper
+  
+  # Render the Zeep Mobile phone registration form
+  #
+  # Example:
+  #   <%= zeep_form(user_id) %>
+  #
+  def zeep_form(user_id = '')
+    render :partial => 'zeep_sms/form', :locals => {:user_id => user_id}
+  end
+end

data/lib/app/models/zeep_sms.rb

@@ -0,0 +1,101 @@
+require 'rubygems'
+require 'zeep/messaging'
+
+class ZeepSms < ActiveRecord::Base
+  RAILS_ROOT ||= File.dirname(__FILE__) + '/../../../..'
+  file = YAML::load(IO.read("#{RAILS_ROOT}/config/zeep_it.yml"))
+  
+  # Zeep Mobile keys extracted from config/zeep_it.yml
+  SECRET_KEY = file['SECRET_KEY']
+  API_KEY = file['API_KEY']
+  
+  # Send any SMS by providing the user loging and body
+  #
+  # Example:
+  #   ZeepSms::send_sms('user_id', 'body of SMS')
+  def self.send_sms(login, body)
+    Zeep::Base.configure_credentials(self::API_KEY, self::SECRET_KEY)
+    Zeep::Messaging.send_message(login, body)
+  end
+  
+  # Send the SMS 
+  #
+  # Example:
+  #   sms = ZeepSms.new(:login=> 'user_id', :raw =>'body of SMS')
+  #   sms.send_text
+  def send_text
+    Zeep::Base.configure_credentials(self::API_KEY, self::SECRET_KEY)
+    Zeep::Messaging.send_message(self.login, self.raw)
+  end
+  
+  # Parse an SMS for a particular keyword or pattern
+  #
+  # Examples:
+  #   parse_for(:keyword => 'user:') 
+  #     => returns the text found after the keywork and before the next space
+  #   parse_for(:pattern => /[0-9]/) 
+  #     => returns the text found after the first digit and before the next space
+  #   parse_for(:common => 'twitter')
+  #     => returns the text found after the first '@' and before the next space
+  #   parse_for({:common => 'bang'}, true)
+  #     => returns the text found between the previous space and the next space
+  #     => removing the '!' in between
+  #
+  # Also returns the rest of the SMS omitting the 5-8 code in the beginning
+  def parse_sms(hash={}, keepPrevious=false)
+    prev = /.*/
+    if keepPrevious
+      prev = ''
+    end
+    key, rest = ''
+    result = {:key => key, :rest => rest}
+    keyword = extract_keyword(hash)
+    key = parse_for(self.raw, keyword, keepPrevious)
+    rest = self.raw.sub(/#{keyword}#{key}\s+/, '')
+    rest.sub!(/[\w]+\s+{1}/, '').chomp!
+    result = {:key => key, :rest => rest}
+  end
+  
+private
+  def extract_keyword(hash={}) #:nodoc:
+    keyword = ''
+    if !hash[:keyword].blank?
+      keyword = hash[:keyword]
+    elsif !hash[:pattern].blank?
+        keyword = hash[:pattern]
+    elsif !hash[:common].blank?
+      if hash[:common] == 'twitter'
+        keyword = '@'
+      elsif hash[:common] == 'hashtag'
+        keyword = '#'
+      elsif hash[:common] == 'USD'
+        keyword = '$'
+      elsif hash[:common] == 'percent'
+        keyword = '%'
+      elsif hash[:common] == 'bang'
+        keyword = '!'
+      elsif hash[:common] == 'colon'
+        keyword = ':'
+      end
+    end
+    keyword
+  end
+  
+  def parse_for(body, keyword, keepPrevious=false) #:nodoc:
+    prev = /.*/
+    if keepPrevious
+      prev = ''
+    end
+    result = ''
+    unless keyword.blank?
+      body.split(/\s+/).each do |word|
+        regex = /#{keyword}/
+        if regex.match(word)
+          result = word.sub(/#{prev}#{keyword}/, '')
+          break
+        end
+      end
+    end
+    result
+  end
+end

data/lib/app/views/zeep_sms/_form.erb

@@ -0,0 +1,10 @@
+<% user_id ||= ' ' %>
+
+<div class="zeep-help">
+To receive text messages please make sure you have created a zeepmobile account below (widget may take a few seconds to load).  Ads may be inserted with your text messages, but you will not be spammed.
+</div>
+<iframe 
+  style="width: 100%; height: 300px; border: none;" 
+  id="zeep_mobile_settings_panel" 
+  src="https://secure.zeepmobile.com/subscription/settings?api_key=<%= ZeepSms::API_KEY %>&user_id=<%= user_id %>">
+</iframe>

data/lib/app/views/zeep_sms/index.erb

@@ -0,0 +1,6 @@
+<h3>Create your Zeep Mobile accound</h3>
+
+<!-- Example of displaying the Zeep Mobile form for registering a phone number -->
+<!-- A unique ID should be passed on to identify the user -->
+<% user_id = @user_id.nil? ? '' : @user_id %>
+<%= zeep_form(user_id) %>

data/lib/db/migrate/20090719024916_create_zeep_sms.rb

@@ -0,0 +1,13 @@
+class CreateZeepSms < ActiveRecord::Migration #:nodoc:
+  def self.up
+    create_table :zeep_sms do |t|
+      t.string   "raw"
+      t.string   "login"
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :zeep_sms
+  end
+end

data/lib/zeep/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Zeep Mobile (zeepmobile.com)
+
+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 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/lib/zeep/README

@@ -0,0 +1,42 @@
+= Zeep Mobile Messaging - SMS Made Easy.
+
+With just a few lines of code, Zeep Mobile's API lets your web app communicate with your users over SMS. Zeep Mobile makes it easy to:
+
+    * Manage your users' mobile content subscriptions
+    * Send and receive SMS content 
+
+These libraries take care of the HTTP Header signing and posting to the HTTP endpoint.
+
+= Development
+
+http://code.google.com/p/zeep-messaging/ is the home of this project. For read-only access to the subversion repo; this should sort you out:
+
+$ svn checkout http://zeep-messaging.googlecode.com/svn/ruby/	trunk/ zeep-messaging-read-only  
+
+= Installing zeep-messaging
+
+Until we start publishing to rubyforge (coming soon) you'll have to get the latest gem from here:
+
+http://code.google.com/p/zeep-messaging/downloads/list
+
+Download it and then:
+
+$ gem install zeep-messaging-0.1.X.gem
+
+= Getting Started
+
+* Head to http://zeepmobile.com/ and get a developer account. 
+* Open your account page: https://secure.zeepmobile.com/account/
+* Register a new application.
+* Note your API_KEY and SECRET_KEY
+
+	require 'rubygems' # Only required if you've installed the gem version
+	require 'zeep/messaging'
+
+	Zeep::Base.configure_credentials(<your api key>, <your secret key>)
+	
+	Zeep::send_message(<user_id>, "'Art thou not Romeo, and a Montague?'")
+
+Wasn't that easy?
+
+As always, any and all feedback is appreciated. You can find me at simon@zeepmobile.com.