mitake_sms 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0145815894a3f478ba54c0cc151d8753f0dd99bab584128fdeaad3a5e37bf7b
+  data.tar.gz: 8a83a7ed6f9b43cced0aa4a1130f361669f0043d78767603f505d7465b3aa773
+SHA512:
+  metadata.gz: ec120586bd986581175e851ed2a974cc9452ba1e8f964fa59dad0b23a9564671f62d205339d5f82e90d0fcd21f696c115ef4159c60a88d78a6be6255421e36d4
+  data.tar.gz: 1716857937144e700d23a88445468856cbd67c7bd5e921e2ac32987216f24acaab4ebba161dadd58fbcce9641c11fbcfe6be307a940e315b3f0b803237818363

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--color
+--order random

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-05-24
+### Added
+- Initial stable release
+- Added SMS sending functionality
+- Support for both single and batch SMS sending
+- Basic error handling and configuration system
+- SimpleCov and SimpleCov-Cobertura for code coverage reporting
+- GitHub Actions workflow for automated testing and code coverage
+- Codecov integration with coverage badge in README
+
+### Changed
+- Refactored configuration system using `Dry::Configurable`
+- Updated error handling with error classes under `MitakeSms::Client` namespace
+- Updated `.gitignore` to exclude `.rspec_status`
+
+### Fixed
+- Fixed `method_missing` issue in configuration system
+- Fixed error class references in tests

data/README.md

@@ -0,0 +1,124 @@
+# MitakeSms
+
+[![codecov](https://codecov.io/gh/7a6163/mitake_sms/graph/badge.svg?token=QNRP1N3TOP)](https://codecov.io/gh/7a6163/mitake_sms)
+
+A Ruby client for the Mitake SMS API, providing a simple and efficient way to send SMS messages through the Mitake SMS service.
+
+## Features
+
+- Send single SMS messages
+- Send batch SMS messages
+- Configurable API settings
+- Simple and intuitive API
+- Comprehensive error handling
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mitake_sms', github: '7a6163/mitake_sms'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install mitake_sms
+```
+
+## Usage
+
+### Configuration
+
+Before using the gem, you need to configure it with your Mitake SMS API credentials:
+
+```ruby
+require 'mitake_sms'
+
+MitakeSms.configure do |config|
+  config.username = 'your_username'  # Your Mitake SMS API username
+  config.password = 'your_password'  # Your Mitake SMS API password
+  config.api_url = 'https://smsapi.mitake.com.tw/api/mtk/'  # Default API URL
+end
+```
+
+### Sending a Single SMS
+
+```ruby
+# Send a simple SMS
+response = MitakeSms.send_sms('0912345678', 'Hello, this is a test message!')
+
+if response.success?
+  puts "Message sent successfully! Message ID: #{response.message_id}"
+  puts "Remaining points: #{response.account_point}"
+else
+  puts "Failed to send message: #{response.error}"
+end
+
+# With additional options
+response = MitakeSms.send_sms(
+  '0912345678',
+  'Hello with options!',
+  from: 'YourBrand',
+  response_url: 'https://your-callback-url.com/delivery-reports',
+  client_id: 'your-client-reference-id'
+)
+```
+
+### Sending Multiple SMS in Batch
+
+```ruby
+messages = [
+  { to: '0912345678', text: 'First message' },
+  { to: '0922333444', text: 'Second message', from: 'YourBrand' },
+  { to: '0933555777', text: 'Third message', response_url: 'https://your-callback-url.com/reports' }
+]
+
+response = MitakeSms.batch_send(messages)
+
+if response.success?
+  puts "Batch sent successfully!"
+  puts "Message ID: #{response.message_id}"
+  puts "Remaining points: #{response.account_point}"
+else
+  puts "Failed to send batch: #{response.error}"
+end
+```
+
+### Error Handling
+
+The gem provides specific error classes for different types of errors:
+
+```ruby
+begin
+  response = MitakeSms.send_sms('invalid', 'test')
+rescue MitakeSms::Client::AuthenticationError => e
+  puts "Authentication failed: #{e.message}"
+rescue MitakeSms::Client::InvalidRequestError => e
+  puts "Invalid request: #{e.message}"
+rescue MitakeSms::Client::ServerError => e
+  puts "Server error: #{e.message}"
+rescue MitakeSms::Client::Error => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/7a6163/mitake_sms.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/mitake_sms/client.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require_relative 'configuration'
+require_relative 'response'
+
+module MitakeSms
+  class Client
+    class Error < StandardError; end
+    class AuthenticationError < Error; end
+    class InvalidRequestError < Error; end
+    class ServerError < Error; end
+
+    # Initialize a new MitakeSms::Client
+    # @param config [MitakeSms::Configuration] configuration object
+    def initialize(config = nil)
+      @config = config || MitakeSms.config
+      @connection = build_connection
+    end
+
+    # Send a single SMS
+    # @param to [String] recipient phone number
+    # @param text [String] message content
+    # @param options [Hash] additional options
+    # @option options [String] :from sender ID
+    # @option options [String] :response_url callback URL for delivery reports
+    # @option options [String] :client_id client reference ID
+    # @return [MitakeSms::Response] response object
+    def send_sms(to, text, options = {})
+      params = {
+        username: @config.username,
+        password: @config.password,
+        dstaddr: to,
+        smbody: text.encode('BIG5', invalid: :replace, undef: :replace, replace: '?')
+      }.merge(options.slice(:from, :response_url, :client_id))
+
+      response = @connection.post('SmSend', params)
+      handle_response(response)
+    end
+
+    # Send multiple SMS in a single request
+    # @param messages [Array<Hash>] array of message hashes
+    #   Each hash should contain :to and :text keys, and can include :from, :response_url, :client_id
+    # @return [MitakeSms::Response] response object
+    def batch_send(messages)
+      params = {
+        username: @config.username,
+        password: @config.password,
+        smbody: messages.map do |msg|
+          to = msg[:to]
+          text = msg[:text].to_s.encode('BIG5', invalid: :replace, undef: :replace, replace: '?')
+          "#{to}:#{text}"
+        end.join("\n")
+      }
+      response = @connection.post('SmBulkSend', params)
+      handle_response(response)
+    end
+
+    private
+
+    def build_connection
+      Faraday.new(url: @config.api_url) do |conn|
+        conn.request :url_encoded
+        conn.request :multipart
+        conn.adapter Faraday.default_adapter
+        conn.options.timeout = @config.timeout
+        conn.options.open_timeout = @config.open_timeout
+      end
+    end
+
+    def handle_response(response)
+      case response.status
+      when 200
+        Response.new(response.body)
+      when 401
+        raise AuthenticationError, 'Invalid username or password'
+      when 400
+        raise InvalidRequestError, 'Invalid request parameters'
+      when 500..599
+        raise ServerError, "Server error: #{response.status}"
+      else
+        raise Error, "Unexpected error: #{response.status}"
+      end
+    end
+  end
+end

data/lib/mitake_sms/configuration.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'dry/configurable'
+
+module MitakeSms
+  class Configuration
+    extend Dry::Configurable
+
+    setting :username, default: ENV['MITAKE_USERNAME']
+    setting :password, default: ENV['MITAKE_PASSWORD']
+    setting :api_url, default: 'https://smsapi.mitake.com.tw/api/mtk/'
+    setting :timeout, default: 30
+    setting :open_timeout, default: 5
+    
+    # Provide direct access to configuration values at the class level
+    class << self
+      def username
+        config.username
+      end
+      
+      def username=(value)
+        config.username = value
+      end
+      
+      def password
+        config.password
+      end
+      
+      def password=(value)
+        config.password = value
+      end
+      
+      def api_url
+        config.api_url
+      end
+      
+      def api_url=(value)
+        config.api_url = value
+      end
+      
+      def timeout
+        config.timeout
+      end
+      
+      def timeout=(value)
+        config.timeout = value
+      end
+      
+      def open_timeout
+        config.open_timeout
+      end
+      
+      def open_timeout=(value)
+        config.open_timeout = value
+      end
+    end
+  end
+
+  # Methods for the MitakeSms module itself
+  class << self
+    def configure
+      yield(config) if block_given?
+    end
+
+    # Return the Dry::Configurable object directly
+    def config
+      Configuration.config
+    end
+  end
+end

data/lib/mitake_sms/response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MitakeSms
+  class Response
+    attr_reader :raw_response, :code, :message_id, :account_point, :error
+
+    def initialize(raw_response)
+      @raw_response = raw_response
+      parse_response(raw_response)
+    end
+
+    def success?
+      @code == '1'
+    end
+
+    def error?
+      !success?
+    end
+
+    private
+
+    def parse_response(response)
+      return unless response.is_a?(String)
+      
+      # Split by newline and create a hash from key=value pairs
+      @parsed_response = {}
+      response.each_line do |line|
+        key, value = line.strip.split('=', 2)
+        @parsed_response[key] = value if key && value
+      end
+      
+      @code = @parsed_response['statuscode']
+      @message_id = @parsed_response['msgid']
+      @account_point = @parsed_response['AccountPoint']
+      @error = @parsed_response['Error']
+    end
+  end
+end

data/lib/mitake_sms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MitakeSms
+  VERSION = "1.0.0"
+end

data/lib/mitake_sms.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'mitake_sms/version'
+require_relative 'mitake_sms/configuration'
+require_relative 'mitake_sms/response'
+require_relative 'mitake_sms/client'
+
+module MitakeSms
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class InvalidRequestError < Error; end
+  class ServerError < Error; end
+
+  class << self
+    # Configure the gem
+    # @yield [MitakeSms::Configuration] the configuration object
+    # @example
+    #   MitakeSms.configure do |config|
+    #     config.username = 'your_username'
+    #     config.password = 'your_password'
+    #   end
+    def configure
+      yield(config) if block_given?
+    end
+
+    # Get the current configuration
+    # @return [Dry::Configurable::Config] the configuration object
+    def config
+      Configuration.config
+    end
+
+    # Create a new client with the current configuration
+    # @return [MitakeSms::Client] a new client instance
+    def client
+      @client ||= Client.new
+    end
+
+    # Send a single SMS message
+    # @param to [String] recipient phone number
+    # @param text [String] message content
+    # @param options [Hash] additional options
+    # @option options [String] :from sender ID
+    # @option options [String] :response_url callback URL for delivery reports
+    # @option options [String] :client_id client reference ID
+    # @return [MitakeSms::Response] response object
+    def send_sms(to, text, options = {})
+      client.send_sms(to, text, options)
+    end
+
+    # Send multiple SMS messages in a single request
+    # @param messages [Array<Hash>] array of message hashes
+    #   Each hash should contain :to and :text keys, and can include :from, :response_url, :client_id
+    # @return [MitakeSms::Response] response object
+    def batch_send(messages)
+      client.batch_send(messages)
+    end
+  end
+end

data/sig/mitake_sms.rbs

@@ -0,0 +1,4 @@
+module MitakeSms
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: mitake_sms
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zac
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A simple and efficient Ruby client for sending SMS messages through Mitake
+  SMS API
+email:
+- 579103+7a6163@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/mitake_sms.rb
+- lib/mitake_sms/client.rb
+- lib/mitake_sms/configuration.rb
+- lib/mitake_sms/response.rb
+- lib/mitake_sms/version.rb
+- sig/mitake_sms.rbs
+homepage: https://github.com/7a6163/mitake_sms
+licenses: []
+metadata:
+  homepage_uri: https://github.com/7a6163/mitake_sms
+  source_code_uri: https://github.com/7a6163/mitake_sms
+  changelog_uri: https://github.com/7a6163/mitake_sms/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A Ruby client for Mitake SMS API
+test_files: []