cm-sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ae5829f7cdabf0ba1718966f9c60d8385652c23
+  data.tar.gz: ccce1ca4e19521f593939c4aeb9ddbe4ec5eadbb
+SHA512:
+  metadata.gz: 1653ab8d2a9a400ed8264557eeb2bc5c9b7dcb09df4411920c315f467c427d8e5c8eaf169eaff7293b2b6527ee15b39d3eb32bf6beb29e049ef515b9ddaf6286
+  data.tar.gz: 0ec72afd8498809c8de78ecbe6e84d2f8a54948f4290db9f52cefa17e7a119e8b48a2116c336cddc6b4add37342b097e8a681ac654327f2888fceaf9b35c3b55

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+coverage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cm-sms.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 itschn
+
+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,41 @@
+# Cm::Sms
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cm/sms`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cm-sms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cm-sms
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cm-sms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cm/sms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cm-sms.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cm_sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cm-sms"
+  spec.version       = CmSms.version
+  spec.authors       = ["itschn"]
+  spec.email         = ["michael.rueffer@hitfoxgroup.com"]
+
+  spec.summary       = %q{Wrapper for the CM SMS Gateway API.}
+  spec.description   = %q{Send text messages by means of the HTTP protocol with the service of https://www.cmtelecom.com.}
+  spec.homepage      = "https://github.com/HitFox/cm-sms"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    spec.add_runtime_dependency "phony", "~> 2.12"
+    spec.add_runtime_dependency "builder", "~> 3.2"
+  else
+    spec.add_dependency "phony", "~> 2.15"
+    spec.add_dependency "builder", "~> 3.2"
+  end
+end

data/lib/cm-sms.rb

@@ -0,0 +1 @@
+require 'cm_sms'

data/lib/cm_sms.rb

@@ -0,0 +1,20 @@
+require 'cm_sms/configuration'
+
+module CmSms
+  autoload :Messenger, 'cm_sms/messenger'
+  autoload :Message, 'cm_sms/message'
+  autoload :MessageDelivery, 'cm_sms/message_delivery'
+  autoload :DeliveryJob, 'cm_sms/delivery_job' if defined?(ActiveJob)
+  
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    
+    alias :config :configuration
+  end
+end

data/lib/cm_sms/configuration.rb

@@ -0,0 +1,26 @@
+module CmSms
+  class Configuration
+    class ProductTokenMissing < ArgumentError; end
+    class EndpointMissing < ArgumentError; end
+    class PathMissing < ArgumentError; end
+    
+    ENDPOINT = 'https://sgw01.cm.nl'
+    PATH     = '/gateway.ashx'
+    
+    attr_accessor :from, :to, :product_token, :endpoint, :path
+    
+    alias :'api_key=' :'product_token='  
+    
+    def endpoint
+      @endpoint || ENDPOINT
+    end
+    
+    def path
+      @path || PATH
+    end
+    
+    def defaults
+      @defaults ||= { from: from, to: to }
+    end
+  end
+end

data/lib/cm_sms/gem_version.rb

@@ -0,0 +1,15 @@
+module CmSms
+  # Returns the version of the currently loaded Action Mailer as a <tt>Gem::Version</tt>
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/cm_sms/message.rb

@@ -0,0 +1,81 @@
+require 'builder'
+require 'phony'
+require 'cm_sms/request'
+
+module CmSms
+  class Message
+    class FromMissing < ArgumentError; end
+    class ToMissing < ArgumentError; end
+    class BodyMissing < ArgumentError; end
+    class ToUnplausible < ArgumentError; end
+    
+    attr_accessor :from, :to, :body, :dcs, :reference
+    
+    def initialize(attributes = {})
+      @from          = attributes[:from]
+      @to            = attributes[:to]
+      @dcs           = attributes[:dcs]
+      @body          = attributes[:body]
+      @reference     = attributes[:reference]
+      
+      @product_token = CmSms.config.product_token
+    end
+    
+    def receiver_plausible?      
+      receiver_present? && Phony.plausible?(to)
+    end
+    
+    def receiver_present?
+      !to.nil? && !to.empty?
+    end
+    
+    def sender_present?
+      !from.nil? && !from.empty?
+    end
+    
+    def body_present?
+      !body.nil? && !body.empty?
+    end
+    
+    def product_token_present?
+      !@product_token.nil? && !@product_token.empty?
+    end
+    
+    def request
+      Request.new(to_xml)
+    end
+    
+    def deliver
+      raise CmSms::Configuration::ProductTokenMissing.new("Please provide an valid product key.\nAfter signup at https://www.cmtelecom.de/, you will find one in your settings.") unless product_token_present?
+      
+      request.perform
+    end
+    
+    def deliver!
+      raise FromMissing.new('The from attribute is missing.') unless sender_present?
+      raise ToMissing.new('The to attribute is missing.') unless receiver_present?
+      raise BodyMissing.new('The body of the message is missing.') unless body_present?
+      raise ToUnplausible.new("THe given to attribute is not a plausible phone number.\nMaybe the country code is missing.") unless receiver_plausible?
+      
+      deliver
+    end
+    
+    def to_xml
+      builder = Builder::XmlMarkup.new
+      builder.instruct! :xml, version: '1.0'
+
+      xml = builder.MESSAGES do |m|
+        m.AUTHENTICATION do |authentication|
+          authentication.PRODUCTTOKEN @product_token
+        end
+        m.MSG do |msg|
+          msg.FROM from
+          msg.TO to
+          msg.DCS dcs if dcs
+          msg.BODY body
+          msg.REFERENCE reference if reference
+        end
+      end
+    end
+  end
+end

data/lib/cm_sms/message_delivery.rb

@@ -0,0 +1,38 @@
+require 'delegate'
+
+module CmSms
+  class MessageDelivery < Delegator
+    def initialize(messenger, message_method, *args) #:nodoc:
+      @messenger      = messenger
+      @message_method = message_method
+      @args           = args
+    end
+
+    def __getobj__ #:nodoc:
+      @obj ||= @messenger.send(:new).send(@message_method, *@args).message
+    end
+    
+    alias :message :__getobj__
+
+    def __setobj__(obj) #:nodoc:
+      @obj = obj
+    end
+
+    def deliver_now!
+      message.deliver!
+    end
+
+    def deliver_now
+      message.deliver
+    end
+    
+    def inspect
+      prefix = "#<#{self.class}:0x#{self.__id__.to_s(16)}"
+      parts  = instance_variables.map { |var| "#{var}=#{instance_variable_get(var).inspect}" }
+      str    = [prefix, parts, ']>'].join(' ')
+
+      str.taint if tainted?
+      str
+    end
+  end
+end

data/lib/cm_sms/messenger.rb

@@ -0,0 +1,51 @@
+module CmSms
+  class Messenger
+    
+    attr_accessor :from, :to, :body, :dcs
+    
+    def initialize(attributes = {})
+      self.class.default_params ||= {}
+      
+      @from = attributes[:from] || self.class.default_params[:from]
+      @to   = attributes[:to] || self.class.default_params[:to]
+      @dcs  = attributes[:dcs] || self.class.default_params[:dcs]
+      @body = attributes[:body]
+    end
+    
+    def content(attributes = {})
+      attributes.each { |attr, value| send("#{attr}=", value) }
+      self
+    end
+    
+    def message
+      @message ||= CmSms::Message.new(from: from, to: to, dcs: dcs, body: body)
+    end
+    
+    def self.method_missing(method_name, *args) # :nodoc:
+      if new.respond_to?(method_name.to_s)
+        CmSms::MessageDelivery.new(self, method_name, *args)
+      else
+        super
+      end
+    end
+    
+    def self.respond_to_missing?(method_name, *args) # :nodoc:
+      new.respond_to?(method_name.to_s) || super
+    end
+    
+    def self.default_params
+      @@default_params ||= CmSms.config.defaults
+    end
+
+    def self.default_params=(params = {})
+      @@default_params = params
+    end
+    
+    def self.default(hash = {})
+      self.default_params = CmSms.config.defaults.merge(hash).freeze
+      default_params
+    end
+    
+  end
+end
+  

data/lib/cm_sms/request.rb

@@ -0,0 +1,26 @@
+require 'cm_sms/response'
+
+module CmSms
+  class Request
+    attr_accessor :body
+    
+    attr_reader :response
+    
+    def initialize(body)
+      @body     = body
+      @endpoint = CmSms.config.endpoint
+      @path     = CmSms.config.path
+    end
+    
+    def perform
+      raise CmSms::Configuration::EndpointMissing.new("Please provide an valid api endpoint.\nIf you leave this config blank, the default will be set to https://sgw01.cm.nl.") if @endpoint.nil? || @endpoint.empty?
+      raise CmSms::Configuration::PathMissing.new("Please provide an valid api path.\nIf you leave this config blank, the default will be set to /gateway.ashx.") if @path.nil? || @path.empty?
+
+      uri = URI.parse(@endpoint)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        @response = Response.new(http.post(@path, body, initheader = { 'Content-Type' => 'application/xml' }))
+      end
+      response
+    end
+  end
+end

data/lib/cm_sms/response.rb

@@ -0,0 +1,23 @@
+module CmSms
+  class Response
+    attr_reader :net_http_response, :body, :code
+    
+    def initialize(net_http_response)
+      @net_http_response = net_http_response
+      @body              = @net_http_response.body
+      @code              = @net_http_response.code
+    end
+    
+    def success?
+      body.empty? && code.to_i == 200
+    end
+    
+    def failure?
+      !success?
+    end
+    
+    def error
+      body.sub('Error: ERROR', '').strip
+    end
+  end
+end

data/lib/cm_sms/version.rb

@@ -0,0 +1,7 @@
+require_relative 'gem_version'
+
+module CmSms
+  def self.version
+    gem_version
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: cm-sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- itschn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: phony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Send text messages by means of the HTTP protocol with the service of
+  https://www.cmtelecom.com.
+email:
+- michael.rueffer@hitfoxgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cm-sms.gemspec
+- lib/cm-sms.rb
+- lib/cm_sms.rb
+- lib/cm_sms/configuration.rb
+- lib/cm_sms/gem_version.rb
+- lib/cm_sms/message.rb
+- lib/cm_sms/message_delivery.rb
+- lib/cm_sms/messenger.rb
+- lib/cm_sms/request.rb
+- lib/cm_sms/response.rb
+- lib/cm_sms/version.rb
+homepage: https://github.com/HitFox/cm-sms
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Wrapper for the CM SMS Gateway API.
+test_files: []