txtlocal 0.0.1

data/.autotest

@@ -0,0 +1,5 @@
+Autotest.add_hook :initialize do |at|
+  at.add_mapping(%r%^lib/txtlocal/(.*)\.rb$%, true) do |_, m|
+    "spec/#{m[1]}_spec.rb"
+  end
+end

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+txtlocal.komodoproject
+README.html
+api_login.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--debug

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in txtlocal.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    txtlocal (0.0.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    addressable (2.2.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    columnize (0.3.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    linecache (0.43)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  bundler (>= 1.0.0)
+  json
+  rspec
+  ruby-debug
+  txtlocal!
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 epiGenesys Limited
+
+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.md

@@ -0,0 +1,46 @@
+# txtlocal.co.uk API Wrapper
+
+This gem is intended to provide a simple API for sending text messages via txtlocal's API.
+
+## Installing
+
+Add the gem to your gemfile
+
+  gem 'txtlocal', :git => 'git://github.com/epigenesys/txtlocal.git'
+
+## Usage
+
+Configure the default settings
+
+    Txtlocal.config do |c|
+      c.from = "My App"
+      c.username = "txtlocal_username"
+      c.password = "txtlocal_password"
+    end
+
+Use Txtlocal.send_message to send messages
+
+    Txtlocal.send_message("You have 1 new friend request!", "07729435xxx")
+
+Or create a message manually
+
+    msg = Txtlocal::Message.new
+    msg.body = "Tickets will be available tomorrow morning at 9am"
+    msg.recipients = ["0712 3893 xxx", "447923176xxx"]
+    msg.add_recipient "+447729435xxx"
+    msg.send!
+
+You can override the sender on a per message basis
+
+    Txtlocal.send_message("You have 1 new friend request!", "07729435xxx", :from => "someone")
+
+    msg = Txtlocal::Message.new
+    msg.from = "a mystery"
+
+## Testing
+
+Set test = true in the configuration to use the API's test mode
+
+    Txtlocal.config.test = true
+    Txtlocal.config.testing?
+      => true

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/txtlocal.rb

@@ -0,0 +1,26 @@
+require 'txtlocal/config'
+require 'txtlocal/message'
+
+module Txtlocal
+  class << self
+
+    def config
+      @config ||= Config.new
+      if block_given?
+        yield @config
+      end
+      @config
+    end
+
+    def reset_config
+      @config = nil
+    end
+
+    def send_message(message, recipients, options={})
+      msg = Txtlocal::Message.new(message, recipients, options)
+      msg.send!
+      msg
+    end
+
+  end
+end

data/lib/txtlocal/config.rb

@@ -0,0 +1,27 @@
+module Txtlocal
+  class Config
+
+    # The default FROM value for sent messages
+    # this can be overridden on a per-message basis
+    attr_accessor :from
+
+    # The username of the txtlocal account to use when accessing the API
+    attr_accessor :username
+
+    # The password of the txtlocal account to use when accessing the API
+    attr_accessor :password
+
+    # Access the API in test mode
+    attr_accessor :test
+
+    def initialize
+      @test = false
+    end
+
+    # Nice wrapper to check if we're testing
+    def testing?
+      !!@test
+    end
+
+  end
+end

data/lib/txtlocal/message.rb

@@ -0,0 +1,90 @@
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Txtlocal
+  class Message
+
+    attr_accessor :body
+    attr_accessor :recipients
+    attr_accessor :from
+
+    attr_accessor :response
+
+    def initialize(message=nil, recipients=nil, options=nil)
+      self.body = message if message
+      self.recipients = recipients if recipients
+      self.options = options if options
+    end
+
+    def body=(body)
+      @body = body.strip.gsub(/\n/, '%n')
+    end
+
+    def recipients
+      @recipients ||= []
+    end
+    def recipients=(recipients)
+      @recipients = []
+      [*recipients].each do |recip|
+        add_recipient(recip)
+      end
+    end
+    def add_recipient(recipient)
+      recipient = recipient.gsub(/\s/, '')
+      recipient = case recipient
+        when /^447\d{9}$/
+          recipient
+        when /^(?:\+447|07)(\d{9})$/
+          "447#{$1}"
+        else
+          return
+      end
+      recipients << recipient
+    end
+
+    def from
+      self.from = Txtlocal.config.from if not @from
+      @from
+    end
+    def from=(from)
+      if from.to_s.length < 3
+        @from = nil
+      else
+        @from = from.strip.gsub(/[^\w ]/, '').to_s[0, 11]
+      end
+    end
+
+    def options=(options)
+      self.from = options[:from] if options.has_key?(:from)
+    end
+
+    def response=(response)
+      if not response.body.empty?
+        @response = {}
+        data = JSON.parse(response.body)
+        data.each_pair do |k, v|
+          key = k.gsub(/\B[A-Z]+/, '_\0').downcase.to_sym
+          @response[key] = v
+        end
+      end
+    end
+
+    API_ENDPOINT = URI.parse("https://www.txtlocal.com/sendsmspost.php")
+    def send!
+      http = Net::HTTP.new(API_ENDPOINT.host, API_ENDPOINT.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      req = Net::HTTP::Post.new(API_ENDPOINT.path)
+      req.set_form_data(:json => 1,
+                        :test => Txtlocal.config.testing? ? 1 : 0,
+                        :from => from,
+                        :message => body,
+                        :selectednums => recipients.join(","),
+                        :uname => Txtlocal.config.username,
+                        :pword => Txtlocal.config.password)
+      result = http.start { |http| http.request(req) }
+      self.response = result
+    end
+  end
+end

data/lib/txtlocal/version.rb

@@ -0,0 +1,3 @@
+module Txtlocal
+  VERSION = "0.0.1"
+end

data/spec/config_spec.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Txtlocal::Config do
+  let(:config) { Txtlocal::Config.new }
+
+  describe "attributes" do
+    attributes = %w(test from username password)
+    attributes.each do |attr|
+      it "should have the '#{attr}' attribute" do
+        value = mock("value")
+        config.send("#{attr}=", value)
+        config.send(attr).should == value
+      end
+    end
+  end
+
+  describe "defaults" do
+    defaults = {
+      :test => false,
+      :username => nil,
+      :password => nil,
+      :from => nil
+    }
+
+    defaults.each_pair do |attr, default|
+      example "#{attr} should default to #{default.inspect}" do
+        config.send(attr).should == default
+      end
+    end
+  end
+
+  describe "testing?" do
+    it "should return false if test isnt true" do
+      config.testing?.should be_false
+    end
+    it "should return true if test is true" do
+      config.test = true
+      config.testing?.should be_true
+    end
+  end
+
+end

data/spec/message_spec.rb

@@ -0,0 +1,187 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Txtlocal::Message do
+  describe "initialize" do
+    let(:new) { Txtlocal::Message.allocate }
+    let(:body) { double("body text") }
+    let(:recipients) { double("recipients") }
+    let(:options) { double("options") }
+    before(:each) do
+      Txtlocal::Message.stub!(:new) do |*args|
+        new.tap do |n|
+          n.send :initialize, *args
+        end
+      end
+    end
+
+    it "should call internal setter methods" do
+      new.should_receive(:body=).with(body)
+      new.should_receive(:recipients=).with(recipients)
+      new.should_receive(:options=).with(options)
+      msg = Txtlocal::Message.new(body, recipients, options)
+    end
+  end
+
+  describe "body text" do
+    let(:msg) { Txtlocal::Message.new }
+    describe "body" do
+      it "should be accessible" do
+        msg.body = "body text"
+        msg.body.should == "body text"
+      end
+      it "should replace newlines with %n" do
+        msg.body = "once\nupon\na time"
+        msg.body.should == "once%nupon%na time"
+      end
+      it "should trim trailing and leading whitespace" do
+        msg.body = "  a short message\n\n"
+        msg.body.should == "a short message"
+      end
+    end
+  end
+
+  describe "recipients" do
+    let(:msg) { Txtlocal::Message.new }
+    describe "accessor" do
+      it "should accept single value" do
+        msg.recipients = "447729416732"
+        msg.recipients.should == ["447729416732"]
+      end
+      it "should accept multiple values" do
+        msg.recipients = ["447729416732", "447923732984"]
+        msg.recipients.should == ["447729416732", "447923732984"]
+      end
+      it "should be using add_recipient internally" do
+        msg.should_receive(:add_recipient).with("447729416732")
+        msg.recipients = "447729416732"
+      end
+    end
+    describe "add_recipient" do
+      it "should accept txtlocal format number" do
+        msg.add_recipient("447729416732")
+        msg.recipients.should == ["447729416732"]
+      end
+      it "should accept 07 format number" do
+        msg.add_recipient("07729416745")
+        msg.recipients.should == ["447729416745"]
+      end
+      it "should accept international format number" do
+        msg.add_recipient("+447729416745")
+        msg.recipients.should == ["447729416745"]
+      end
+      it "should accept numbers with spaces" do
+        msg.add_recipient("07729 457 756")
+        msg.recipients.should == ["447729457756"]
+      end
+      it "should not add invalid numbers" do
+        # TODO: exception here?
+        msg.add_recipient("qwdcs")
+        msg.add_recipient("0114 245 9832")
+        msg.add_recipient("0800 800 8000")
+        msg.recipients.should be_empty
+      end
+    end
+  end
+
+  describe "from" do
+    let(:msg) { Txtlocal::Message.new }
+    before(:each) do
+      Txtlocal.config.from = "default"
+    end
+    after(:each) do
+      Txtlocal.reset_config
+    end
+    it "should default to config.from" do
+      msg.from.should == "default"
+    end
+    it "should be overridable" do
+      msg.from = "overridden"
+      msg.from.should == "overridden"
+    end
+    it "should revert to default if set to nil" do
+      msg.from = "overridden"
+      msg.from.should == "overridden"
+      msg.from = nil
+      msg.from.should == "default"
+    end
+    it "should truncate if set to longer than 11 characters" do
+      msg.from = "123456789012345"
+      msg.from.should == "12345678901"
+    end
+    it "should fail silently if set to less than 3 characters" do
+      msg.from = "12"
+      msg.from.should == "default"
+    end
+    it "should trim whitespace and remove any non alphanumeric or space characters" do
+      msg.from = " a person! "
+      msg.from.should == "a person"
+    end
+  end
+
+  describe "options" do
+    let(:msg) { Txtlocal::Message.new }
+    it "should accept :from" do
+      msg.options = {:from => "my name"}
+      msg.from.should == "my name"
+    end
+  end
+
+  describe "send!" do
+    context "web mocked" do
+      before(:each) do
+        WebMock.disable_net_connect!
+        stub_request(:post, "https://www.txtlocal.com/sendsmspost.php")
+        Txtlocal.config do |c|
+          c.from = "testing"
+          c.username = "testuser"
+          c.password = "testpass"
+          c.test = false
+        end
+      end
+      after(:each) do
+        Txtlocal.reset_config
+      end
+      it "should send data to the API endpoint" do
+        msg = Txtlocal::Message.new("a message", "447729416583")
+        msg.send!
+        WebMock.should have_requested(:post, "https://www.txtlocal.com/sendsmspost.php").with(
+          :body => {'uname' => "testuser", 'pword' => "testpass", 'json' => '1', 'test' => '0',
+                    'from' => "testing", 'selectednums' => "447729416583", 'message' => "a message"}
+        )
+      end
+      it "should comma sepratate multiple recipients" do
+        msg = Txtlocal::Message.new("a message", ["447729416583", "447984534657"])
+        msg.send!
+        WebMock.should have_requested(:post, "https://www.txtlocal.com/sendsmspost.php").with(
+          :body => {'uname' => "testuser", 'pword' => "testpass", 'json' => '1', 'test' => '0',
+                    'from' => "testing", 'selectednums' => "447729416583,447984534657",
+                    'message' => "a message"}
+        )
+      end
+    end
+    context "api test mode" do
+      if not (File.readable?('api_login.rb') and load('api_login.rb') and
+              API_USERNAME and API_PASSWORD)
+        pending "\n" +
+          "Please create a file api_login.rb that defines API_USERNAME and API_PASSWORD " +
+          "to run tests against the real server"
+      else
+        before(:each) do
+          WebMock.allow_net_connect!
+          Txtlocal.config do |c|
+            c.from = "testing"
+            c.username = API_USERNAME
+            c.password = API_PASSWORD
+            c.test = true
+          end
+        end
+        it "should send data to the API endpoint" do
+          msg = Txtlocal::Message.new("a message", "447729467413")
+          msg.send!
+          msg.response.should_not be_nil
+          msg.response[:error].should include "testmode"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+
+require 'txtlocal'
+
+require 'webmock/rspec'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

data/spec/txtlocal_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Txtlocal do
+
+  describe "config" do
+    it "should be accessible" do
+      Txtlocal.config.should be_a Txtlocal::Config
+    end
+    it "should be modifiable with a block" do
+      remember = nil
+      Txtlocal.config do |c|
+        c.should be_a Txtlocal::Config
+        remember = c
+      end
+      Txtlocal.config.should == remember
+    end
+    it "should be resettable" do
+      c = Txtlocal.config
+      Txtlocal.reset_config
+      Txtlocal.config.should_not == c
+    end
+  end
+
+  describe "send_message" do
+    let(:message)      { double("message body") }
+    let(:recipients)   { double("list of recipients") }
+    let(:options)      { double("additional message options") }
+    let(:msg_instance) { double("message instance") }
+
+    it "should construct a Message instance and send! it" do
+      msg_instance.should_receive(:send!).with(no_args)
+      Txtlocal::Message.should_receive(:new).with(message, recipients, options) { msg_instance }
+      Txtlocal.send_message(message, recipients, options).should == msg_instance
+    end
+  end
+
+end

data/txtlocal.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/txtlocal/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "txtlocal"
+  s.version     = Txtlocal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Glen Mailer"]
+  s.email       = ["glen@epigenesys.co.uk"]
+  s.homepage    = "https://github.com/epigenesys/txtlocal"
+  s.summary     = "An API wrapper for txtlocal.co.uk"
+  s.description = "An API wrapper for txtlocal.co.uk"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  #s.rubyforge_project         = "txtlocal"
+
+  s.add_dependency "json"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "ruby-debug"
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "webmock"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: txtlocal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Glen Mailer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70290906322080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70290906322080
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70290906316680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70290906316680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70290906315460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290906315460
+- !ruby/object:Gem::Dependency
+  name: ruby-debug
+  requirement: &70290906311120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290906311120
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &70290906306060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290906306060
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70290906301840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290906301840
+description: An API wrapper for txtlocal.co.uk
+email:
+- glen@epigenesys.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/txtlocal.rb
+- lib/txtlocal/config.rb
+- lib/txtlocal/message.rb
+- lib/txtlocal/version.rb
+- spec/config_spec.rb
+- spec/message_spec.rb
+- spec/spec_helper.rb
+- spec/txtlocal_spec.rb
+- txtlocal.gemspec
+homepage: https://github.com/epigenesys/txtlocal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: An API wrapper for txtlocal.co.uk
+test_files: []