penny_sms_muncher 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+
+## PROJECT::SPECIFIC

data/API_RESPONSES.txt

@@ -0,0 +1,96 @@
+**BLANK MESSAGE**
+--- 
+fault: 
+- value: 
+  - struct: 
+    - member: 
+      - name: 
+        - faultCode
+        value: 
+        - i4: 
+          - "403"
+      - name: 
+        - faultString
+        value: 
+        - string: 
+          - "Error: API KEY is not vaild, contact support@pennysms.com"
+
+**BAD API KEY**
+--- 
+fault: 
+- value: 
+  - struct: 
+    - member: 
+      - name: 
+        - faultCode
+        value: 
+        - i4: 
+          - "403"
+      - name: 
+        - faultString
+        value: 
+        - string: 
+          - "Error: API KEY is not vaild, contact support@pennysms.com"
+
+**BAD PHONE NUMBER**
+--- 
+fault: 
+- value: 
+  - struct: 
+    - member: 
+      - name: 
+        - faultCode
+        value: 
+        - i4: 
+          - "500"
+      - name: 
+        - faultString
+        value: 
+        - string: 
+          - "Error: invalid cell number"
+
+**INVALID PHONE #**        
+<?xml version="1.0" ?><methodResponse><fault><value><struct><member><name>faultCode</name><value><i4>500</i4></value></member><member><name>faultString</name><value><string>Error: unsupported cell number</string></value></member></struct></value></fault></methodResponse>
+  
+--- 
+fault: 
+- value: 
+  - struct: 
+    - member: 
+      - name: 
+        - faultCode
+        value: 
+        - i4: 
+          - "500"
+      - name: 
+        - faultString
+        value: 
+        - string: 
+          - "Error: unsupported cell number"
+          
+          
+**??? (ALTERNATE BAD PHONE NUMBER?)**
+--- 
+fault: 
+- value: 
+  - struct: 
+    - member: 
+      - name: 
+        - faultCode
+        value: 
+        - i4: 
+          - "501"
+      - name: 
+        - faultString
+        value: 
+        - string: 
+          - "Error: Try again later"
+          
+**ALL GOOD**
+--- 
+params: 
+- param: 
+  - value: 
+    - string: 
+      - OK
+          

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 chris A
+
+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,46 @@
+h1. PennySMS Muncher
+
+A little bit of code to make PennySMS XML requests.
+
+<pre><code>
+>> require 'penny_sms'
+>> include PennySMSMuncher
+>> req = PennySMS::XMLRequest.new(penny_sms_api_key, from_email, phone_number, body)
+...
+>> response = req.send_sms
+...      # PennySMSMuncher::PennySMS::Response object>> response.success?
+=> true
+>> response.status
+=> "OK"
+>> req = PennySMS::XMLRequest.new(penny_sms_api_key, from_email, '6175551234', body)
+...
+>> response = req.send_sms 
+...      # PennySMSMuncher::PennySMS::Response object
+>> response.status
+=> error"
+>> response.success?
+=> false
+>> response.fault_code
+=> "500"
+>> response.fault_name
+=> "Error: unsupported cell number"
+>> response.raw 
+=> <Net::HTTPOK 200 OK  readbody=true>
+>> response.raw.body
+=> "<?xml version="1.0" ?><methodResponse><fault><value><struct><member><name>faultCode</name><value><i4>500</i4></value></member><member><name>faultString</name><value><string>Error: unsupported cell number</string></value></member></struct></value></fault></methodResponse>\n"
+>> response.data        
+...       # LibXML::XML::Document object
+</code>
+</pre>
+
+
+Here is the minimalist PennySMS doc: https://www.pennysms.com/docs_xml
+
+h2. Note on Patches/Pull Requests
+
+* Go ahead and make the JSON work.
+* And feel free to chat me up.
+
+h2. Copyright
+
+Copyright (c) 2010 chris A. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "penny_sms_muncher"
+    gem.summary = %Q{A little bit of code to make PennySMS XML requests.}
+    gem.description = %Q{A little bit of code to make PennySMS XML requests. But not JSON requests right now.}
+    gem.email = "chris@whatbirdthings.com"
+    gem.homepage = "http://github.com/whatbird/penny_sms_muncher"
+    gem.authors = ["chris A", "Matthew Shanley"]
+  
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+
+    gem.add_dependency('addressable', '>= 2.1.1')
+    gem.add_dependency('libxml-ruby', '>= 1.1.3')
+  
+  
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "penny_sms_muncher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/penny_sms.rb

@@ -0,0 +1,124 @@
+require 'net/http'
+require 'erb'
+
+require 'addressable/uri'
+require 'xml'
+
+module PennySMSMuncher
+  module PennySMS
+    class Request
+      attr_accessor :api_key, :text, :url, :from_email, :phone_number, :response
+
+      def initialize(api_key, from_email, phone_number, text, api_url=nil)
+        self.url = Addressable::URI.parse(api_url || @api_url)
+        self.phone_number = phone_number
+        self.from_email = from_email
+        self.text = text
+        self.api_key = api_key
+        self.from_email = from_email
+      end
+
+      def request
+        req = Net::HTTP::Post.new url.path,
+          initheader = {'Content-Type' => @content_type}
+        req.body = template
+        req
+      end
+
+      def send_sms
+        resp = Net::HTTP.new(url.host).start {|http| http.request(request) }
+
+        if resp.is_a? Net::HTTPSuccess
+          self.response = Response.new(resp)
+        else
+          raise APIError, "PennySMS API changed or busted. Or gem obsolete."
+        end
+      end
+    end
+
+    class Response
+      attr_accessor :data, :raw, :status
+
+      def initialize(raw)
+        self.raw = raw
+        self.data = XML::Parser.string(raw.body).parse # JSON?
+        self.set_status
+        self
+      end
+
+      def success?
+        !fault_code
+      end
+
+      def set_status
+        if fault
+          self.status = 'error'
+        else
+          self.status = data.find('//params//string').first.content
+        end
+      end
+
+      def fault_code
+        fault.find('//i4').first.content if fault
+      end
+
+      def fault_name
+        fault.find('//string').first.content if fault
+      end
+
+      def fault
+        return unless data && !data.find('//fault').empty?
+        data.find('//fault//member')[0]
+      end
+    end
+
+    class XMLRequest < Request
+      def initialize(*args)
+        @api_url = 'http://api.pennysms.com/xmlrpc'
+        @rpc_method = 'send'
+        @content_type = 'text/xml'
+        super
+      end
+
+      def template
+        ERB.new(%q{<?xml version="1.0"?>
+          <methodCall>
+          <methodName><%= @rpc_method %></methodName>
+          <params>
+          <param>
+          <value><string><%= api_key %></string></value>
+          </param>
+          <param>
+          <value><string><%= from_email %></string></value>
+          </param>
+          <param>
+          <value><string><%= phone_number %></string></value>
+          </param>
+          <param>
+          <value><string><%= text %></string></value>
+          </param>
+          </params>
+        </methodCall>}.gsub(/^  /, '')).result(binding)
+      end
+    end
+
+    # DOES NOT WORK 2009-12-22
+    class JSONRequest < Request
+      def initialize(*args)
+        raise NoMethodError, "JSONRequest not working. Figure it out though and let me know"
+        @api_url = 'http://api.pennysms.com/jsonrpc'
+        @rpc_method = 'send'
+        @content_type = 'text/json'
+        super
+      end
+
+      def template
+        {:method => @rpc_method,
+          :params => [api_key,from_email,phone_number,text]
+        }.to_json
+      end
+    end
+
+    class APIError < Exception; end
+  end
+end

data/penny_sms_muncher.gemspec

@@ -0,0 +1,61 @@
+# 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{penny_sms_muncher}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["chris A", "Matthew Shanley"]
+  s.date = %q{2010-01-12}
+  s.description = %q{A little bit of code to make PennySMS XML requests. But not JSON requests right now.}
+  s.email = %q{chris@whatbirdthings.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "API_RESPONSES.txt",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "lib/penny_sms.rb",
+     "penny_sms_muncher.gemspec",
+     "spec/penny_sms_muncher_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/whatbird/penny_sms_muncher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A little bit of code to make PennySMS XML requests.}
+  s.test_files = [
+    "spec/penny_sms_muncher_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<addressable>, [">= 2.1.1"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<addressable>, [">= 2.1.1"])
+      s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<addressable>, [">= 2.1.1"])
+    s.add_dependency(%q<libxml-ruby>, [">= 1.1.3"])
+  end
+end
+

data/spec/penny_sms_muncher_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__)) + "/../lib/penny_sms.rb"
+include PennySMSMuncher
+
+
+module PennySMSHelper
+  def failing_sms
+    @phone = '5555555555'
+    @email = 'mouse house'
+    @message = "Mouse is in the house!"
+    @req = PennySMS::XMLRequest.new('api_key', @email, @phone,@message)
+  end
+
+  def fault_body
+    '<?xml version="1.0" ?><methodResponse><fault><value><struct><member><name>faultCode</name><value><i4>500</i4></value></member><member><name>faultString</name><value><string>Error: unsupported cell number</string></value></member></struct></value></fault></methodResponse>'
+  end
+  
+  def success_body
+    '<?xml version="1.0" ?><methodResponse><params><param><value><string>OK</string></value></param></params></methodResponse>'
+  end
+end
+
+
+describe "PennySMSMuncher::PennySms" do
+  include PennySMSHelper
+
+  describe 'creating' do
+
+    describe 'XMLRequest' do
+      it 'should set the url' do
+        req = PennySMS::XMLRequest.new('api_key', nil, nil,nil)
+        req.url.path.should match(/xml/)
+      end
+    end
+
+    describe 'JSONRequest' do
+      it 'should set the url'
+    end
+  end
+
+  describe 'template' do
+    describe 'XMLRequest' do
+      before(:each) do
+        failing_sms
+      end
+
+      it 'should include the phone_number' do
+        @req.template.should match(@phone)
+      end
+      it 'should include the email' do
+        @req.template.should match(@email)
+      end
+      it 'should include the message'  do
+        @req.template.should match(@message)
+      end
+      it 'should include the api_key'    do
+        @req.template.should match('api_key')
+      end
+
+    end
+    describe 'JSONRequest' do
+      it 'should include the phone_number'
+      it 'should include the email'
+      it 'should include the message'
+      it 'should include the api_key'
+    end
+  end
+
+  describe 'making the API call' do
+    describe 'fails' do
+      it 'should raise an error if the API call fails' do
+        failing_sms
+        Net::HTTP.any_instance.stubs(:start).returns "bogus"
+        lambda{@req.send_sms}.should raise_error(PennySMS::APIError)
+      end
+    end
+
+    describe 'succeeds' do
+      describe 'with errors' do
+        before(:each) do
+          failing_sms
+          http_mock = mock('Net::HTTPSuccess')
+          http_mock.stubs( :code => '200',
+            :message => "OK",
+            :content_type => "text/xml",
+            :body => fault_body,
+            :is_a? => Net::HTTPSuccess)
+          Net::HTTP.any_instance.stubs(:start).returns http_mock
+          @response = @req.send_sms
+        end
+
+        it "should return a response object"  do
+          @response.class.should == PennySMS::Response
+        end
+
+        it 'should set the status' do
+          @response.status.should == 'error'
+        end
+
+        it 'should not be successful' do
+          @response.should_not be_success
+        end
+
+        it 'should set the fault_code' do
+          @response.fault_code.should == '500'
+        end
+
+        it 'should set the fault_name' do
+          @response.fault_name.should match(/unsupported cell/)
+        end
+      end
+
+      describe 'with no errors' do
+        before(:each) do
+          failing_sms
+          http_mock = mock('Net::HTTPSuccess')
+          http_mock.stubs( :code => '200',
+            :message => "OK",
+            :content_type => "text/xml",
+            :body => success_body,
+            :is_a? => Net::HTTPSuccess)
+          Net::HTTP.any_instance.stubs(:start).returns http_mock
+          @response = @req.send_sms
+        end
+
+        it "should return a response object"  do
+          @response.class.should == PennySMS::Response
+        end
+
+        it 'should set the status' do
+          @response.status.downcase.should == 'ok'
+        end
+
+        it 'should be successful' do
+          @response.should be_success
+        end
+
+        it 'should not set the fault_code' do
+          @response.fault_code.should be_nil
+        end
+
+        it 'should not set the fault_name' do
+          @response.fault_name.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'penny_sms'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: penny_sms_muncher
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- chris A
+- Matthew Shanley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: A little bit of code to make PennySMS XML requests. But not JSON requests right now.
+email: chris@whatbirdthings.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- API_RESPONSES.txt
+- LICENSE
+- Rakefile
+- VERSION
+- lib/penny_sms.rb
+- penny_sms_muncher.gemspec
+- spec/penny_sms_muncher_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- README.textile
+has_rdoc: true
+homepage: http://github.com/whatbird/penny_sms_muncher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A little bit of code to make PennySMS XML requests.
+test_files: 
+- spec/penny_sms_muncher_spec.rb
+- spec/spec_helper.rb