twsms2 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c364ff8657babc7b1f0a6ffaf9a47fd1e90e427a
+  data.tar.gz: 93cde1c61bf791e3076aadf52c26cb1e9f3db347
+SHA512:
+  metadata.gz: c9ed81c3fea24c3fa7c267c906fb5240f245fa98a9663e602e08808d9f35d9fd7a245012bdeda5ef872a217154f01f62b30388edc9ca9ff5314a04cefca65bc1
+  data.tar.gz: bc2d634dc09216746267526735643629d13b9b3c32d026575c7d806b8de4e2019fa20132d1fccc6cb66e19b30a03826a64d013c60436ab3976a68a037d337fab

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Guanting Chen
+
+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,36 @@
+# Twsms2
+
+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/twsms2`. 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 'twsms2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twsms2
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/twsms2.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twsms2"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twsms2/exception.rb

@@ -0,0 +1,5 @@
+module Twsms2
+  class Error < StandardError; end
+  class ClientError < Error; end
+  class ServerError < Error; end
+end

data/lib/twsms2/formatter.rb

@@ -0,0 +1,55 @@
+module Twsms2
+  module Formatter
+    def match_string(rule, string)
+      match_data = rule.match(string)
+      match_data.nil? ? nil : match_data[1]
+    end
+
+    def format_send_message_info(original_info)
+      new_info = {
+        access_success: false,
+        message_id: nil,
+        error: nil
+      }
+
+      code_text  = match_string(/<code>(?<code>\w+)<\/code>/, original_info)
+      message_id_text = match_string(/<msgid>(?<message_id>\d+)<\/msgid>/, original_info)
+
+      new_info[:access_success] = !code_text.nil? && !message_id_text.nil? && code_text == '00000'
+
+      if new_info[:access_success]
+        new_info[:message_id] = message_id_text
+      else
+        new_info[:error] = "TWSMS:CODE_NOT_FOUND"
+        new_info[:error] = "TWSMS:#{code_text}" unless code_text.nil?
+        new_info[:error].upcase!
+      end
+
+      new_info
+    end
+
+    def format_balance_info(original_info)
+      new_info = {
+        access_success: false,
+        message_quota: 0,
+        error: nil
+      }
+
+      code_text  = match_string(/<code>(?<code>\w+)<\/code>/, original_info)
+      point_text = match_string(/<point>(?<point>\d+)<\/point>/, original_info)
+
+      new_info[:access_success] = !code_text.nil? && !point_text.nil? && code_text == '00000'
+
+      if new_info[:access_success]
+        new_info[:message_quota] = point_text.to_i
+      else
+        new_info[:error] = "TWSMS:CODE_NOT_FOUND"
+        new_info[:error] = "TWSMS:#{code_text}" unless code_text.nil?
+        new_info[:error].upcase!
+      end
+
+      new_info
+    end
+
+  end
+end

data/lib/twsms2/network.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'cgi'
+
+module Twsms2
+  module Network
+    def get(host, request_uri, params = {})
+      uri = URI('https://' + host + request_uri)
+      uri.query = query_string(params.merge(username: @username, password: @password))
+
+      message = Net::HTTP::Get.new(uri.request_uri)
+      message['User-Agent'] = @user_agent
+
+      parse(request(uri, message), host)
+    end
+
+    def parse(http_response, host)
+      case http_response
+      when Net::HTTPSuccess
+        http_response.body
+      when Net::HTTPClientError
+        raise ClientError, "#{http_response.code} response from #{host}"
+      when Net::HTTPServerError
+        raise ServerError, "#{http_response.code} response from #{host}"
+      else
+        raise Error, "#{http_response.code} response from #{host}"
+      end
+    end
+
+    def request(uri, message)
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+      http.request(message)
+    end
+
+    def query_string(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
+    end
+
+    def escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/twsms2/version.rb

@@ -0,0 +1,3 @@
+module Twsms2
+  VERSION = "0.9.0"
+end

data/lib/twsms2.rb

@@ -0,0 +1,41 @@
+require 'twsms2/version'
+require 'twsms2/network'
+require 'twsms2/exception'
+require 'twsms2/formatter'
+
+module Twsms2
+  class Client
+    include Twsms2::Network
+    include Twsms2::Formatter
+
+    def initialize(options={})
+      @user_agent = "twsms2/#{VERSION}"
+      @api_host   = options.fetch(:host) { 'api.twsms.com' }
+      @username   = options.fetch(:username) { ENV.fetch('TWSMS_USERNAME') }
+      @password   = options.fetch(:password) { ENV.fetch('TWSMS_PASSWORD') }
+    end
+
+    def account_is_available
+      balance_info = get_balance
+
+      ok = balance_info[:message_quota] > 0 && balance_info[:access_success]
+    end
+
+    def send_message(options={})
+      options[:to]      ||= nil
+      options[:content] ||= nil
+      options[:long]    = options[:long] || options[:long].nil? ? :Y : :N
+      options[:popup]   = options[:popup] ? :Y : :N
+
+      response = get(@api_host, '/smsSend.php', popup: options[:popup], mo: :N, longsms: options[:long], mobile: options[:to], message: options[:content], drurl: '')
+
+      format_send_message_info(response)
+    end
+
+    def get_balance
+      response = get(@api_host, '/smsQuery.php', deltime: :N, checkpoint: :Y, mobile: '', msgid: '')
+
+      format_balance_info(response)
+    end
+  end
+end

data/twsms2.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twsms2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twsms2"
+  spec.version       = Twsms2::VERSION
+  spec.authors       = ["Guanting Chen"]
+  spec.email         = ["cgt886@gmail.com"]
+  spec.license       = "MIT"
+  spec.platform      = Gem::Platform::RUBY
+  spec.summary       = %q{2016 台灣簡訊 TwSMS API ( for ruby >= 2.1 )}
+  spec.description   = %q{2016 台灣簡訊 TwSMS API ( for ruby >= 2.1 )}
+  spec.homepage      = "https://github.com/guanting112"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: twsms2
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Guanting Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 2016 台灣簡訊 TwSMS API ( for ruby >= 2.1 )
+email:
+- cgt886@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twsms2.rb
+- lib/twsms2/exception.rb
+- lib/twsms2/formatter.rb
+- lib/twsms2/network.rb
+- lib/twsms2/version.rb
+- twsms2.gemspec
+homepage: https://github.com/guanting112
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: 2016 台灣簡訊 TwSMS API ( for ruby >= 2.1 )
+test_files: []