merb_signupto 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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

@@ -0,0 +1,4 @@
+merb_signupto
+=================
+
+A plugin for the Merb framework that provides ....

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'lib/merb_signupto/version'
+
+PLUGIN = "merb_signupto"
+NAME = "merb_signupto"
+AUTHOR = "Tim Perrett"
+EMAIL = "hello@timperrett.com"
+HOMEPAGE = "http://blog.timperrett.com"
+SUMMARY = "Merb plugin that provides intergrated connectivity to the signupto SMS gateway"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = MerbSignupto::Version::STRING
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.4.0')
+  s.add_dependency('signupto', '>= 0.0.2')
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,merb_generators}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb_signupto.rb
+Add your Merb rake tasks to lib/merb_signupto/merbtasks.rb

data/lib/merb/sms_controller.rb

@@ -0,0 +1,79 @@
+module Merb
+  
+  # The SMS controller lets you send text messages seamlessly from within merb
+  # to get started add a dependency to your new merb application then do:
+  #
+  # $ rake signupto:setup
+  # 
+  # This then generates a configuration file where you must fill it in with
+  # your signup.to account details. These are global configurations for the applications.
+  # 
+  # Next, generate a new sms controller like so:
+  #
+  # $ script/generate signupto_controller Demo my_method some_thing another
+  # 
+  # In the above command, "Demo" is the name of the class, and the others are actions
+  # within our controller. Once you have your newly created class, you can call the sms
+  # methods from your main controllers. 
+  #
+  # def index
+  #   send_sms(ExampleMessenger, :some_method, { :from => '02UK', :to => '4445265485' })
+  # end
+  # 
+  # send_sms(KlassYouWantToCall, :method_on_class, {})
+  # 
+  # paramater 3 is an options hash, of which valid options are:
+  # :to => "recipeitns phone number" (string, -)
+  # :from => 'from' that will appear on recipient mobile (string, 12)
+  # 
+  class SmsController < AbstractController
+    
+    self._template_root = File.expand_path(self._template_root / "../messages/views")
+    class_inheritable_accessor :_sms_klass
+    self._sms_klass  = Signupto::Action::Sender
+    
+    attr_accessor :params, :mailer, :mail
+    attr_reader   :session, :base_controller
+    
+    # You can initialize an SmsController with a series of parameters that can
+    # be used by methods in the class. You can also pass in a controller
+    # object, which will be available to the SmsController methods as
+    # base_controller.
+    def initialize(params = {}, controller = nil)
+      @params = params
+      @base_controller = controller
+      @session = (controller && controller.session) || {}
+      super
+    end
+    
+    def render_sms(options = @method)
+      @_missing_templates = false # used to make sure that at least one template was found
+      value = render({:format=>:text, :clean_context=>true, :text => @method, :layout => :none})
+      @message_options = {:body => value}
+    end
+    
+    # Builds the message and account objects from the global configs
+    # and merges them with the paramates passed in from the main
+    # application controller send_sms call.
+    def dispatch_and_deliver(method, sms_params)
+      @method = method
+      # run the method in the subclass which in turn calls
+      # the render_sms method defined above
+      dispatch(method)
+      # take ther result and merge it with the options passed 
+      # in from the application controller subclass
+      @message_options.merge!(sms_params)
+      sms_message = Signupto::Message.new(@message_options[:to], @message_options[:body], @message_options[:from])
+      global_config = Merb::Plugins.config[:merb_signupto]
+      sms_account = Signupto::Account.new(global_config[:account_hash], global_config[:customer_number])
+      if sms_message
+        begin 
+          self.class._sms_klass.new(sms_account, sms_message)
+        rescue => e
+          MERB_LOGGER.error(e)
+        end
+      end
+    end
+    
+  end
+end

data/lib/merb_signupto/configurator.rb

@@ -0,0 +1,26 @@
+module MerbSignupto
+  class Configurator
+    
+    # Attempt to load in the YAML formated configuration file which
+    # should be located in config/uproduce.yml. If no file exsists, 
+    # you will need to run rake xmpie_icp:setup to get the stub configuration
+    def self.load_config_from_file
+      if defined?(::Merb::Server)
+        if ::Merb::Server.config[:merb_root]
+          signupto_file_path = File.join(::Merb::Server.config[:merb_root],'config','signupto.yml')
+          if FileTest.exist?(signupto_file_path) 
+            return YAML.load_file(signupto_file_path)
+          else
+            puts "##############################"
+            puts "Signupto configuration missing"
+            puts "##############################"
+            # exit()
+          end
+        else
+          puts "[signupto] Running outside of the merb container..."
+        end
+      end
+    end
+    
+  end
+end

data/lib/merb_signupto/controller_extension.rb

@@ -0,0 +1,20 @@
+module MerbSignupto
+  module ControllerExtension
+    
+    # you can now call this in any of your ordinary controllers like so:
+    #
+    # def index
+    #   send_sms(ExampleMessenger, :some_method, { :from => '02UK', :to => '4445265485' })
+    # end
+    #
+    # You must use international format for your phone numbers, rather than using +44 or 078 
+    # for example.
+    #
+    # for more information on how to use the SmsController please see the docs
+    # in sms_controller.rb 
+    def send_sms(klass, method, mail_params, send_params = nil)
+      klass.new(send_params || params, self).dispatch_and_deliver(method, mail_params)
+    end
+    
+  end
+end

data/lib/merb_signupto/tasks/merbtasks.rb

@@ -0,0 +1,25 @@
+namespace :signupto do
+  desc "Create a stub uProduce config file"
+  task :setup do
+    uproduce_config = File.join(MERB_ROOT, 'config','signupto.yml')
+    unless File.exist?(uproduce_config)
+      File.open(uproduce_config, 'w') do |f|
+        f.puts %{# Please fill in valid details below, and ensure
+# that you have set your IP in the signup.to dashboard before you 
+# attempt to start sending SMS from your application
+account_hash: "your_account_has"
+customer_number: "your_customer_number"
+}
+
+puts "############################"
+puts "CONFIG FILE HAS BEEN CREATED"
+puts "############################"
+
+      end
+    else
+      puts "############################"
+      puts "CONFIG FILE ALREADY EXSISTS"
+      puts "############################"
+    end
+  end
+end

data/lib/merb_signupto/version.rb

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

data/lib/merb_signupto.rb

@@ -0,0 +1,28 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  if defined?(MERB_PATHS)
+    MERB_PATHS.pop
+    MERB_PATHS << '/app/messages/**/*.rb'
+    MERB_PATHS << "/config/router.rb"
+  end
+
+  require 'merb_signupto/controller_extension'
+  require 'merb/sms_controller'
+  require 'merb_signupto/configurator'
+  
+  Merb::Controller.class_eval do
+    include MerbSignupto::ControllerExtension
+  end
+  
+  # load in the configuration from the YAML file
+  merb_comfig = MerbSignupto::Configurator.load_config_from_file()
+  Merb::Plugins.config[:merb_signupto] = {
+   :account_hash => merb_comfig['account_hash'],
+   :customer_number => merb_comfig['customer_number']
+  }
+  
+  Merb::Plugins.add_rakefiles "merb_signupto/tasks/merbtasks"
+end

data/merb_generators/signupto_controller/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/merb_generators/signupto_controller/signupto_controller_generator.rb

@@ -0,0 +1,59 @@
+class SignuptoControllerGenerator < RubiGen::Base
+  
+  attr_reader :name
+  
+  def initialize(*runtime_args)
+    super
+    usage if runtime_args.empty?
+    argument_array = runtime_args.flatten
+    input_name = argument_array.slice!(0).snake_case.to_const_string
+    @class_name = "#{input_name}Messenger" 
+    @actions = argument_array.delete_if {|i| i.is_a?(Hash)  }
+  end
+
+  def manifest
+    record do |m|
+      filename = @class_name.snake_case
+      # Ensure appropriate folder(s) exists
+      m.directory File.join('app','messages','views')
+      m.directory File.join('app','messages','views', filename)
+      m.template  'signupto_controller_template.rb', 
+                  File.join('app','messages',"#{filename}.rb"), 
+                  :assigns => {  :class_name => @class_name, :actions => @actions }
+      for method in @actions
+        m.template 'sms_message_template.text.erb', 
+                   File.join('app','messages','views',filename,"#{method.snake_case}.text.erb"),
+                   :assigns => { :method_name => method }
+      end
+
+      
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/merb_generators/signupto_controller/templates/signupto_controller_template.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < Merb::SmsController
+  <% for method in actions %>
+  def <%=method%>
+    render_sms
+  end
+  <% end %>
+end

data/merb_generators/signupto_controller/templates/sms_message_template.text.erb

@@ -0,0 +1 @@
+Stub message for <%= method_name %>

data/spec/merb_signupto_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_signupto" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: merb_signupto
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+date: 2008-01-04 00:00:00 +00:00
+summary: Merb plugin that provides intergrated connectivity to the signupto SMS gateway
+require_paths: 
+- lib
+email: hello@timperrett.com
+homepage: http://blog.timperrett.com
+rubyforge_project: 
+description: Merb plugin that provides intergrated connectivity to the signupto SMS gateway
+autorequire: merb_signupto
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Tim Perrett
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb
+- lib/merb/sms_controller.rb
+- lib/merb_signupto
+- lib/merb_signupto/configurator.rb
+- lib/merb_signupto/controller_extension.rb
+- lib/merb_signupto/tasks
+- lib/merb_signupto/tasks/merbtasks.rb
+- lib/merb_signupto/version.rb
+- lib/merb_signupto.rb
+- spec/merb_signupto_spec.rb
+- spec/spec_helper.rb
+- merb_generators/signupto_controller
+- merb_generators/signupto_controller/signupto_controller_generator.rb
+- merb_generators/signupto_controller/templates
+- merb_generators/signupto_controller/templates/signupto_controller_template.rb
+- merb_generators/signupto_controller/templates/sms_message_template.text.erb
+- merb_generators/signupto_controller/USAGE
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: signupto
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.2
+    version: