mitake 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 588de0a453cae48483cf27f37c74b2db75e5c5682ed08ac10a3057cd4e478a75
+  data.tar.gz: c338e59a0bcd8df934aae0f52be63c96a7a27bab641efddab5b4758250e1fac8
+SHA512:
+  metadata.gz: 8b6fa1a4e0e4eee00e87a0f8635ccc57d43a3e8cf09fa43775e1c0313ff0f9043efaa269dcb82cc7c2bb9d64959efc45cde7fd66fac5be63893da9bb16c24947
+  data.tar.gz: c64cc7fe68bd9f0b4734bb865927b9d1ecfae1d9ad34018a6d6d66f372b274eb12f5914014029b1f2ae5d82211869d66dc2be95553cb4ba871cee5ba9332faa1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.overcommit.yml

@@ -0,0 +1,34 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  AuthorName:
+    enabled: false
+
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+  TrailingWhitespace:
+    enabled: true
+
+PostCheckout:
+  ALL: # Special hook name that customizes all hooks of this type
+    quiet: true # Change all post-checkout hooks to only display output on failure
+
+  IndexTags:
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at elct9620@frost.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mitake.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    mitake (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    childprocess (3.0.0)
+    diff-lcs (1.3)
+    iniparse (1.4.4)
+    jaro_winkler (1.5.4)
+    overcommit (0.51.0)
+      childprocess (>= 0.6.3, < 4)
+      iniparse (~> 1.4)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  bundler-audit (~> 0.6.1)
+  mitake!
+  overcommit (~> 0.51.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.76.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Zheng Xian Qiu
+
+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,101 @@
+# Mitake (三竹簡訊)
+[![Build Status](https://travis-ci.com/elct9620/mitake.svg?branch=master)](https://travis-ci.com/elct9620/mitake) [![Gem Version](https://badge.fury.io/rb/mitake.svg)](https://badge.fury.io/rb/mitake) [![Maintainability](https://api.codeclimate.com/v1/badges/2da932d77d1a2d37a18a/maintainability)](https://codeclimate.com/github/elct9620/mitake/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/2da932d77d1a2d37a18a/test_coverage)](https://codeclimate.com/github/elct9620/mitake/test_coverage)
+
+This is a Ruby implement to help user send SMS via 三竹簡訊 easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mitake'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mitake
+
+## Usage
+
+To send the SMS, you need to specify the username and password.
+
+```ruby
+Mitake.credential = Mitake::Credential.new('YOUR_USERNAME', 'YOUR_PASSWORD')
+```
+
+If you prefer to config it by the environment variable, please setup `MITAKE_USERNAME` and `MITAKE_PASSWORD`, the gem will automatic create credential.
+
+> The default server is `https://smsapi.mitake.com.tw` if you use a different server, please specify it manual.
+
+```ruby
+# Get the balance in the account
+puts "Point: #{Mitake::Balance.amount}"
+
+# Create recipient and give phone number
+recipient = Mitake::Recipient.new(phone_number: '09xxxxxxxx', name: 'John')
+
+# Create message with body
+message = Mitake::Message.new(recipient: recipient, body: 'Hello World!')
+
+# Delivery message
+message.delivery
+
+# Check status
+puts message.status unless message.sent?
+```
+
+### Switch Credential
+
+If you have multiple credentials, you can switch it in the runtime.
+
+```ruby
+external = Mitake::Credential.new('xxx', 'xxx')
+
+Mitake.use(external) do
+  # Replace default credential with external
+end
+
+# Switch back to use default credential
+```
+
+### Message Attributes
+
+|Name|Type|Description
+|----|----|-----------
+|id|String| `Readonly` The message ID from Mitake
+|source_id|String| The customize identity, if same `source_id` send to Mitake, it will response duplicate flag
+|recipient|Mitake::Recipient| The recipient of message
+|body|String| The message body
+|schedule_at|Time| The schedule time to send message
+|expired_at|Time| The message expire time, max value is `+ 24h`
+|webhook_url|String| The Callback URL for Mitake response status
+|duplicate|TrueClass/FalseClass| `Readonly` The message is duplicate (already sent)
+|status_code|Integer| `Readonly` The message status
+
+## Roadmap
+
+* [ ] Rspec tests
+* [ ] Message
+  * [x] Delivery
+  * [ ] Batch Delivery
+  * [ ] Webhook
+  * [ ] Query Status
+  * [ ] Cancel
+
+## 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/elct9620/mitake. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Mitake project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elct9620/mitake/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mitake'
+
+# 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(__FILE__)

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/mitake.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'mitake/version'
+require 'mitake/credential'
+require 'mitake/balance'
+require 'mitake/message'
+
+# The Mitake API Client
+#
+# @since 0.1.0
+module Mitake
+  # @since 0.1.0
+  # @api private
+  LOCK = Mutex.new
+
+  # Switch credential
+  #
+  # @param credential [Mitake::Credential] the api credential
+  # @param _block [Proc] the actions use specify credential
+  #
+  # @since 0.1.0
+  def self.use(credential, &_block)
+    temp = credential
+    LOCK.synchronize do
+      self.credential = credential
+      yield
+      self.credential = temp
+    end
+  end
+
+  # The credential
+  #
+  # @return [Mitake::Credential] the current credential
+  #
+  # @since 0.1.0
+  def self.credential
+    @credential ||= Credential.new
+  end
+
+  # Set credential
+  #
+  # @param credential [Mitake::Credential] the new credential
+  #
+  # @since 0.1.0
+  def self.credential=(credential)
+    @credential = credential
+  end
+end

data/lib/mitake/api.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'mitake/parser'
+require 'mitake/api/get'
+require 'mitake/api/post'
+
+module Mitake
+  # Provide API Interface
+  #
+  # @since 0.1.0
+  # @api private
+  module API
+    class Error < RuntimeError; end
+
+    # @since 0.1.0
+    # @api private
+    def self.included(base)
+      base.class_eval do
+        @method = 'Get'
+
+        extend ClassMethods
+      end
+    end
+
+    # @since 0.1.0
+    # @api private
+    module ClassMethods
+      # Set/Get the api path
+      #
+      # @param path [String] the api endpoint path
+      # @return [String] if path not given, return previous value
+      #
+      # @since 0.1.0
+      # @api private
+      def path(path = nil)
+        return @path if path.nil?
+
+        @path = path
+      end
+
+      # Set/Get the api method
+      #
+      # @param method [String] the api request method
+      # @return [String] if method not given, return previous value
+      #
+      # @since 0.1.0
+      # @api private
+      def method(method = nil)
+        return @method if method.nil?
+
+        @method = method.to_s.capitalize
+      end
+
+      # Set response field mapping
+      #
+      # @param from [String] the response field
+      # @param to [String] the target field
+      #
+      # @since 0.1.0
+      # @api private
+      def map(from, to)
+        @mapping ||= {}
+        @mapping[from.to_s] = to.to_s
+      end
+
+      # Execute API
+      #
+      # @param params [Hash] the API params
+      # @param _block [Proc] the customize process
+      # @return [Mitake::API] the api response
+      #
+      # @since 0.1.0
+      # @api private
+      def execute(params = {}, &_block)
+        res = request(params)
+        raise Mitake::API::Error, res.code unless res.is_a?(Net::HTTPOK)
+
+        items = Parser.new(res).parse.map { |item| rename_attribute(item) }
+        return items.map { |item| new(item) } unless block_given?
+
+        yield items
+      end
+
+      private
+
+      # Send HTTP Request
+      #
+      # @return [Net::HTTPResponse] the http response
+      #
+      # @since 0.1.0
+      # @api private
+      def request(params = {})
+        klass = API.const_get(method)
+        klass.new(path, params).execute
+      end
+
+      # Rename attributes
+      #
+      # @param item [Hash] the source hash
+      #
+      # @since 0.1.0
+      # @api private
+      def rename_attribute(item)
+        item.map do |key, value|
+          [@mapping[key] || key, value]
+        end.to_h
+      end
+    end
+  end
+end