emay_soap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adaa820fd874c6b80d160e11ee8e7ea901afa00e
+  data.tar.gz: 89e3d736557bfb08ba5aa9695c1d7b8da538691f
+SHA512:
+  metadata.gz: ef672da2267802781afabf215f8fb6d417562eb466d231f911c49cee233cb01abf2dd92208a16578f2bcc49f6f255bc75ae1a9d9888f3710616025e29e89d28b
+  data.tar.gz: 4a86710eb5f230913e5af26ef2b3ae9325750f4b37f98f03962bb6040ca53e867e03611b083a5630c0a7cc9e7c2a98458dfe4cc9cb684fed63c7f2cfcaa3a280

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in emay_soap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yuan He
+
+MIT License
+
+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,72 @@
+# EmaySoap
+
+Made easy to use Emay(http://www.emay.cn/) to send sms in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emay_soap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emay_soap
+
+## Usage
+
+#### Setup
+```ruby
+# Provide authentication credentials
+EmaySoap.setup do |c|
+  c.cdkey = 'yourcdkey'
+  c.key = 'yourkeywant to use' # max length 15
+  c.password = 'yourpassword'
+end
+
+client = EmaySoap.client
+```
+
+or
+
+```ruby
+# Provide authentication credentials
+client = EmaySoap::Client.new(cdkey: 'yourcdkey, key: 'yoursessionkey', password: 'yourpassword')
+```
+
+#### Play with API
+
+```ruby
+# Emay requires you register your CD_KEY before send SMS
+client.regist_ex
+
+# List all APIs
+client.operations
+
+# Query Balance
+client.get_balance
+
+# Query each fee of SMS
+client.get_balance
+
+# Send SMS
+client.send_sms
+
+# change your session key
+client.logout
+client.key = 'yournewkey'
+client.regist_ex
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/lenage/emay_soap/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/emay_soap.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emay_soap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "emay_soap"
+  spec.version       = EmaySoap::VERSION
+  spec.authors       = ["Yuan He"]
+  spec.email         = ["lendage@gmail.com"]
+  spec.summary       = %q{Emay SOAP API wrapper in Ruby.}
+  spec.description   = %q{Made easy to use Emay(http://www.emay.cn/) to send sms in Ruby.}
+  spec.homepage      = "https://github.com/lenage/emay_soap"
+  spec.license       = "MIT"
+
+  spec.add_runtime_dependency 'savon', '~> 2.8'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/emay_soap/client.rb

@@ -0,0 +1,89 @@
+require "savon"
+require "emay_soap/configurable"
+
+module EmaySoap
+  class Client
+    include EmaySoap::Configurable
+
+    ENDPOINT = 'http://sdk4report.eucp.b2m.cn:8080/sdk/SDKService?wsdl'.freeze
+
+    def initialize(options = {})
+      EmaySoap::Configurable.setup_keys.each do |k|
+        instance_variable_set(:"@#{k}", options[k] || EmaySoap::Configurable.default_options[k])
+      end
+    end
+
+    def operations
+      savon.operations
+    end
+
+    def operation(action)
+      savon.operation(action)
+    end
+
+    # register cdkey
+    def regist_ex
+      call(:regist_ex, arg2: @password)
+    end
+
+    def regist_detail_info(options)
+      raise 'Detail info required' if options.blank?
+      msg = { arg1: options[:e_name], arg2: options[:link_man],
+              arg4: options[:phone_num], arg5: options[:mobile],
+              arg6: options[:email], arg7: options[:fax],
+              arg8: options[:address], arg9: options[:postcode] }
+      call(:regist_detail_info, msg)
+    end
+
+    def charge_up(cardno, cardpass)
+      call(:charge_up, arg2: cardno, arg3: cardpass)
+    end
+
+    # send SMS out
+    # @params mobiles [String/Array] List of mobiles which send sms, max to 200
+    #         content [String], content of sms
+    #         options [Hash]
+    #                 :send_at [Time] set a time to send sms, send immediately if nil
+    #                 :kind  [String] custom SMS content kind
+    #                 :priority [Integer] SMS priority, from 1 to 5
+    #                 :id SMS ID, [Integer] you can set a SMS ID for your content
+    def send_sms(mobiles, content, options = {})
+      send_at = format_sent_at(options[:send_at]) unless options[:send_at].blank?
+      mobiles = mobiles.is_a?(String) ? [mobiles] : mobiles
+      msg = { arg2: send_at, arg3: mobiles, arg4: content, arg5: options[:kind], arg6: nil, arg7: options[:priority], arg8: options[:id] }
+      call(:send_sms, msg)
+    end
+
+    def serial_pwd_upd(new_password)
+      call(:serial_pwd_upd, arg2: @password, arg3: new_password)
+    end
+
+    # Create all methods via method_missing,
+    def method_missing(method, *args)
+      ary = args.each_with_index.inject([]) do |r, (e, i)|
+        r << ["arg#{i+2}".to_sym, e]
+      end
+      message = Hash[ary]
+      if operations.include?(method)
+        call(method, message)
+      else
+        super
+      end
+    end
+
+    private
+
+    def savon
+      @client ||= Savon.client(wsdl: ENDPOINT)
+    end
+
+    def call(action, message)
+      msg = { arg0: @cdkey, arg1: @key }.merge message
+      savon.call(action, message: msg).body
+    end
+
+    def format_sent_at send_at
+      send_at.strftime('%Y%m%d%H%M%S')
+    end
+  end
+end

data/lib/emay_soap/configurable.rb

@@ -0,0 +1,30 @@
+module EmaySoap
+  module Configurable
+    attr_accessor :cdkey, :key, :password
+
+    class << self
+      def default_options
+        {
+          cdkey: ENV['EMAY_CDKEY'],
+          key: ENV['EMAY_KEY'], # session key, max length is 15
+          password: ENV['EMAY_PASSWORD']
+        }
+      end
+
+      def setup_keys
+        @setup_keys ||= [:cdkey, :key, :password]
+      end
+    end
+
+    def options
+      ary = EmaySoap::Configurable.setup_keys.map do |key|
+        [key, send(key)]
+      end
+      Hash[ary]
+    end
+
+    def setup
+      yield self
+    end
+  end
+end

data/lib/emay_soap/version.rb

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

data/lib/emay_soap.rb

@@ -0,0 +1,14 @@
+require "emay_soap/version"
+require "emay_soap/client"
+require "emay_soap/configurable"
+
+module EmaySoap
+  class << self
+    include EmaySoap::Configurable
+
+    def client
+      @client = EmaySoap::Client.new(options)
+      @client
+    end
+  end
+end

data/spec/emay_soap/client_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe EmaySoap::Client do
+  it '#operations' do
+    expect(EmaySoap::Client.new.operations).to be_kind_of Array
+  end
+
+  it '#operation' do
+    expect(EmaySoap::Client.new.operation(:get_balance)).to be_kind_of Savon::Operation
+  end
+
+  it 'method_missing' do
+    client = EmaySoap.client
+    expect(client.get_balance).to be_kind_of Hash
+    expect(client.get_balance[:get_balance_response]).to be_truthy
+  end
+end

data/spec/emay_soap/configurable_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe EmaySoap::Configurable do
+  it '.setup_keys' do
+    expect(EmaySoap::Configurable.setup_keys).to include(:cdkey)
+  end
+
+  it 'EmaySoap.setup' do
+    EmaySoap.setup do |c|
+      c.cdkey = 'cdkey'
+      c.key = 'key'
+      c.password = 'password'
+    end
+    expect(EmaySoap.options).to be_kind_of Hash
+    expect(EmaySoap.options[:cdkey]).to eq 'cdkey'
+  end
+end

data/spec/emay_soap_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe EmaySoap do
+  context '.client' do
+
+    before(:all) do
+      EmaySoap.setup do |c|
+        c.cdkey = 'some-cd-key'
+        c.key = 'hello'
+        c.password = 'world'
+      end
+    end
+
+    it 'create an EmaySoap::Client' do
+      expect(EmaySoap.client).to be_kind_of EmaySoap::Client
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+require 'emay_soap'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: emay_soap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuan He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Made easy to use Emay(http://www.emay.cn/) to send sms in Ruby.
+email:
+- lendage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- emay_soap.gemspec
+- lib/emay_soap.rb
+- lib/emay_soap/client.rb
+- lib/emay_soap/configurable.rb
+- lib/emay_soap/version.rb
+- spec/emay_soap/client_spec.rb
+- spec/emay_soap/configurable_spec.rb
+- spec/emay_soap_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lenage/emay_soap
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Emay SOAP API wrapper in Ruby.
+test_files:
+- spec/emay_soap/client_spec.rb
+- spec/emay_soap/configurable_spec.rb
+- spec/emay_soap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: