cpsms 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/.rvmrc_example

@@ -0,0 +1,4 @@
+rvm --create 1.9.3@cpsms
+export CPSMS_USERNAME=YourUsername
+export CPSMS_PASSWORD=YourPassword
+export CPSMS_MOBILE_NUMBER=YourMobileNumber

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem 'httparty'
+gem 'libxml-ruby', :platforms => [:ruby]
+gem 'libxml-jruby', :platforms => [:jruby]
+gem 'jruby-openssl', :platforms => [:jruby]
+
+group :test do
+  gem 'minitest'
+  gem 'webmock'
+  gem 'vcr', '~> 2.0.0.rc1'
+  gem 'turn'
+  gem 'rake'
+  gem 'guard-minitest'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    ansi (1.4.2)
+    bouncy-castle-java (1.5.0146.1)
+    crack (0.3.1)
+    ffi (1.0.11)
+    ffi (1.0.11-java)
+    guard (0.10.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-minitest (0.4.0)
+      guard (~> 0.4)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    jruby-openssl (0.7.6.1)
+      bouncy-castle-java (>= 1.5.0146.1)
+    libxml-jruby (1.0.0)
+    libxml-ruby (2.2.2)
+    minitest (2.11.2)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rake (0.9.2.2)
+    thor (0.14.6)
+    turn (0.9.2)
+      ansi
+    vcr (2.0.0.rc1)
+    webmock (1.7.10)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  guard-minitest
+  httparty
+  jruby-openssl
+  libxml-jruby
+  libxml-ruby
+  minitest
+  rake
+  turn
+  vcr (~> 2.0.0.rc1)
+  webmock

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/README.md

@@ -0,0 +1,64 @@
+# CPSMS
+
+A wrapper for the cpsms.dk API.
+
+It will allow you to easily send SMS messages through the API from your Ruby applications.
+
+[![Build Status](https://secure.travis-ci.org/dipth/cpsms.png?branch=master)](http://travis-ci.org/dipth/cpsms)
+
+# Prerequisites
+
+To use the API you need to have an account on cpsms.dk
+
+Once you have the account, you should have the following information:
+
+* username
+* password
+
+You will need this information for all calls to the API.
+
+# Sending an sms
+
+To send an sms simply call the ```CPSMS::SMS.send!``` method
+
+The method takes the following parameters
+
+* **username**: Your cpsms.dk username (*string*)
+* **password**: Your spsms.dk password (*string*)
+* **recipient**: The phone-number of the recipient (*integer*)
+* **message**: The message to send to the recipient (*string - max 459 chars*)
+* **options**: A hash of optional options (described below)
+
+To send a basic sms with the message: "Hello world" to 12345678
+
+    CPSMS::SMS.send! "username", "password", 12345678, "Hello World!"
+
+You can pass a hash of optional options to the method. The possible options and their defaults are as follows
+
+* **from**: A number or string that will be displayed as the sender of the message (*string - max 11 chars*)
+* **url**: A callback url that CPSMS will call with details about the delivery. (See CPSMS's API documentation for more info) (*string - max 100 chars*)
+* **timestamp**: A timestamp that specifies when the sms should be sent. (*Time*)
+* **flash**: If set to true, the sms will be sent as a flash-sms (*boolean*)
+* **group**: Currently not implemented
+
+# Testing
+
+To create new tests or edit existing you need to set your cpsms.dk credentials and a valid mobile number as environment variables.
+
+More specifically you need to set these three environment variables with their respective values:
+
+* CPSMS_USERNAME
+* CPSMS_PASSWORD
+* CPSMS_MOBILE_NUMBER
+
+If you're using RVM, you can copy the supplied ```.rvmrc_example``` file to ```.rvmrc``` and edit the last two lines with your credentials
+
+    export CPSMS_USERNAME=YourUsername
+    export CPSMS_PASSWORD=YourPassword
+    export CPSMS_MOBILE_NUMBER=YourMobileNumber
+
+**Please note:** Your mobile number must be prepended with the country-code, for instance: 4512345678 for a danish number (45).
+
+By doing this, the variables will automatically be set when RVM sets the environment.
+
+If you just wish to run the existing test suite, you don't need to set these values, as VCR will simply use existing recordings for communication with the API.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/cpsms/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/cpsms.rb

@@ -0,0 +1,4 @@
+require "httparty"
+Dir[File.dirname(__FILE__) + '/cpsms/*.rb'].each do |file|
+  require file
+end

data/lib/cpsms/sms.rb

@@ -0,0 +1,50 @@
+module CPSMS
+  require 'xml'
+
+  class SMS
+
+    include HTTParty
+
+    base_uri 'https://www.cpsms.dk'
+
+    def self.send!(username, password, recipient)
+      body = { :username => username,
+               :password => password,
+               :recipient => recipient,
+               :message => "test" }
+      parse_response self.post('/sms/', :body => body).body
+    end
+
+  private
+
+    def self.parse_response(response)
+      xml = XML::Parser.string(response).parse
+
+      error = xml.find_first('//error')
+      self.handle_errors(error.content) if error
+
+      success = xml.find_first('//succes') # cpsms.dk don't know how to spell
+      self.handle_success(success.content) if success
+    end
+
+    def self.handle_errors(error)
+      case error
+      when 'Invalid username/password'
+        raise InvalidCredentialsError
+      end
+    end
+
+    def self.handle_success(success)
+      case success
+      when 'SMS succesfully sent to 0 recipient(s)'
+        raise InvalidRecipientError
+      when 'SMS succesfully sent to 1 recipient(s)'
+        true
+      end
+    end
+
+  end
+
+  class InvalidCredentialsError < StandardError; end
+  class InvalidRecipientError < StandardError; end
+end

data/lib/cpsms/version.rb

@@ -0,0 +1,3 @@
+module CPSMS
+  VERSION = "0.1.0"
+end

data/spec/fixtures/cpsms_cassettes/sms.yml

@@ -0,0 +1,78 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.cpsms.dk/sms/
+    body: username=wrong&password=wrong&recipient=12345678&message=test
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 18 Feb 2012 18:23:23 GMT
+      Server:
+      - Apache/2.2.14 (EL)
+      X-Powered-By:
+      - PHP/5.2.11
+      Content-Length:
+      - '40'
+      Connection:
+      - close
+      Content-Type:
+      - text/html
+    body: <error>Invalid username/password</error>
+    http_version: 
+  recorded_at: Sat, 18 Feb 2012 18:23:19 GMT
+- request:
+    method: post
+    uri: https://www.cpsms.dk/sms/
+    body: username=<USERNAME>&password=<PASSWORD>&recipient=<MOBILE_NUMBER>&message=test
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 18 Feb 2012 18:23:24 GMT
+      Server:
+      - Apache/2.2.14 (EL)
+      X-Powered-By:
+      - PHP/5.2.11
+      Content-Length:
+      - '55'
+      Connection:
+      - close
+      Content-Type:
+      - text/html
+    body: <succes>SMS succesfully sent to 1 recipient(s)</succes>
+    http_version: 
+  recorded_at: Sat, 18 Feb 2012 18:23:20 GMT
+- request:
+    method: post
+    uri: https://www.cpsms.dk/sms/
+    body: username=<USERNAME>&password=<PASSWORD>&recipient=12345678&message=test
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 18 Feb 2012 18:23:25 GMT
+      Server:
+      - Apache/2.2.14 (EL)
+      X-Powered-By:
+      - PHP/5.2.11
+      Content-Length:
+      - '55'
+      Connection:
+      - close
+      Content-Type:
+      - text/html
+    body: <succes>SMS succesfully sent to 0 recipient(s)</succes>
+    http_version: 
+  recorded_at: Sat, 18 Feb 2012 18:23:21 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/lib/cpsms/sms_spec.rb

@@ -0,0 +1,56 @@
+require(File.expand_path('./../../../spec_helper', __FILE__))
+
+describe CPSMS::SMS do
+
+  let(:username)  { ENV.fetch('CPSMS_USERNAME', 'fake-cpsms-username') }
+  let(:password)  { ENV.fetch('CPSMS_PASSWORD', 'fake-cpsms-password') }
+  let(:recipient) { ENV.fetch('CPSMS_MOBILE_NUMBER', 'fake-cpsms-mobile-number') }
+
+  describe "default attributes" do
+    it "must include httparty methods" do
+      CPSMS::SMS.must_include HTTParty
+    end
+
+    it "must have the base url set to the CPSMS API endpoint" do
+      CPSMS::SMS.base_uri.must_equal 'https://www.cpsms.dk'
+    end
+  end
+
+  describe ".send!" do
+    before do
+      VCR.insert_cassette 'sms',
+                          :record => :new_episodes,
+                          :match_requests_on => [:method, :body]
+    end
+    after  { VCR.eject_cassette }
+
+    it "must have a send! method" do
+      CPSMS::SMS.must_respond_to :send!
+    end
+
+    describe "with invalid credentials" do
+      it "raises a CPSMS::InvalidCredentialsError" do
+        proc do
+          CPSMS::SMS.send!("wrong", "wrong", 12345678)
+        end.must_raise CPSMS::InvalidCredentialsError
+      end
+    end
+
+    describe "with valid credentials" do
+      describe "and invalid recipient" do
+        it "raises a CPSMS::InvalidRecipientError" do
+          proc do
+            CPSMS::SMS.send!(username, password, 12345678)
+          end.must_raise CPSMS::InvalidRecipientError
+        end
+      end
+
+      describe "and a valid recipient" do
+        it "returns true" do
+          CPSMS::SMS.send!(username, password, recipient).must_equal true
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+#we need the actual library file
+require(File.expand_path('../../lib/cpsms', __FILE__))
+
+#dependencies
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+require 'turn'
+
+Turn.config do |c|
+ # :outline  - turn's original case/test outline mode [default]
+ c.format  = :outline
+ # use humanized test names (works only with :outline format)
+ c.natural = true
+end
+
+#VCR config
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cpsms_cassettes'
+  c.stub_with :webmock
+  c.filter_sensitive_data('username=<USERNAME>')       { "username=#{ ENV.fetch('CPSMS_USERNAME', 'fake-cpsms-username') }" }
+  c.filter_sensitive_data('password=<PASSWORD>')       { "password=#{ ENV.fetch('CPSMS_PASSWORD', 'fake-cpsms-password') }" }
+  c.filter_sensitive_data('recipient=<MOBILE_NUMBER>') { "recipient=#{ ENV.fetch('CPSMS_MOBILE_NUMBER', 'fake-cpsms-mobile-number') }" }
+
+  # Since HTTParty takes a Hash of body data, we can never be sure that it is
+  # sent in the same order. This can cause VCR to not recognise the request and
+  # therefore not use a previously recorded response.
+  # This overrides VCR's built-in :body matcher to ignore the order of the data
+  c.register_request_matcher :body do |request1, request2|
+    body1 = request1.body.split('&')
+    body2 = request2.body.split('&')
+    (body1 - body2).empty?
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: cpsms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- dipth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-20 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper for the cpsms.dk API
+email:
+- thomas@dippel.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc_example
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/cpsms.rb
+- lib/cpsms/sms.rb
+- lib/cpsms/version.rb
+- spec/fixtures/cpsms_cassettes/sms.yml
+- spec/lib/cpsms/sms_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dipth/cpsms
+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: '0'
+requirements: []
+rubyforge_project: cpsms
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Wrapper for the cpsms.dk API
+test_files:
+- spec/fixtures/cpsms_cassettes/sms.yml
+- spec/lib/cpsms/sms_spec.rb
+- spec/spec_helper.rb