codec_fast_sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fee74c51b4b78963c7c059abc8c2e4cecc586ae57c50ee9473569faa888649c3
+  data.tar.gz: abd5a1e4a5e04ae432926b913bf3dbad235ab10c08b55ed581270d3880291e4b
+SHA512:
+  metadata.gz: be1fb5ccd3a310fc1eab86863dc9e12c8c4614b5e7eb8d8f0c6b996fe094b08f38a33b23495b56f4ab60dadedd96c5d283369e6e219a036a44c75b438e76b435
+  data.tar.gz: fd0e213ac6bf2cae091e841cfa73d7e6fdbb599ab25e2367b569e0dcfe4d2192eb21811091e581f38a78a831466307e9558965de82e2c1915bcfa713ac1b6301

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+Gemfile.lock
+.env
+.byebug_history
+*.gem

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+before_install: gem install bundler -v 2.1.2
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake test
+  - bundle exec rake rubocop

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in codec_fast_sms.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+# CodecFastSms [![Build Status](https://travis-ci.org/sertangulveren/codec_fast_sms.svg?branch=master)](https://travis-ci.org/sertangulveren/codec_fast_sms)
+
+This client allows you to send sms using Codec Fast SMS API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codec_fast_sms'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install codec_fast_sms
+
+## Configuration
+
+Client must be configured before use. Configuration fields are as:
+
+| Field           | Description                                                                                             |
+| --------------- | ------------------------------------------------------------------------------------------------------- |
+| api_host        | Root url of the API.                                                                                    |
+| username        | Your API username.                                                                                      |
+| password        | Your API password.                                                                                      |
+| sender          | Sms sender title.                                                                                       |
+
+### Configuration on Rails Application:
+Create a file in the `config/initializers` directory and configure client in this file as below:
+`# config/initializers/codec_fast_sms.rb`
+```ruby
+CodecFastSms.configure do |config|
+  config.api_host = 'https://fastsms.api.example.com'
+  config.username = 'mysuperapiuser'
+  config.password = 'mYsupeRsecreTqassworld'
+  config.sender = 'MYSUPERCOMPANY'
+end
+```
+### Multiple Configuration
+You can define multiple configurations separated by profile. To do this, you must pass the profile parameter to the `configure` definition.
+If the profile name is not pass in the configuration, it defaults to use `:default`.
+##### Example:
+In this example, to send sms , profile name specified as `settings`.
+`# config/initializers/codec_otp_settings.rb`
+```ruby
+CodecFastSms.configure(:otp_user) do |config|
+  config.api_host = 'https://fastsms.api.example.com'
+  config.username = 'mysuperapiotpuser'
+  config.password = 'mYsupeRsecreTqassworldforOtP'
+  config.sender = 'MYSUPERCOMPANY'
+end
+```
+## Usage
+Initialize a client object before starting process.
+```ruby
+client = CodecFastSms::Client.new
+```
+To send sms, call the method `deliver`.
+```ruby
+phone = '905991112233'
+message = 'Dear Hayri Gülümser, your membership has been activated.'
+client.deliver(phone, message)
+puts client.response
+```
+
+We can pass the profile argument on client initialization to use different configuration.
+```ruby
+client = CodecFastSms::Client.new(profile: :dynamic_settings)
+client.deliver(phone, message)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sertangulveren/codec_fast_sms.
+

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+task default: :test
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'codec_fast_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(__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/codec_fast_sms.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/codec_fast_sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codec_fast_sms'
+  spec.version       = CodecFastSms::VERSION
+  spec.authors       = ['Sertan Gülveren']
+  spec.email         = ['sertangulveren@gmail.com']
+
+  spec.summary       = 'Codec FastSMS Library for Ruby.'
+  spec.description   = 'It is a simple ruby client for Codec FastSMS API.'
+  spec.homepage      = 'https://github.com/sertangulveren/codec_fast_sms'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.require_paths = ['lib']
+  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency('rake', '~> 12.0')
+  spec.add_development_dependency('rubocop', '~> 0.79.0')
+  spec.add_development_dependency('simplecov', '~> 0.17.1')
+  spec.add_development_dependency('webmock', '~> 3.8')
+
+  spec.add_dependency('faraday', '~> 0.11.0')
+end

data/lib/codec_fast_sms.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'codec_fast_sms/version'
+require 'codec_fast_sms/configuration'
+require 'codec_fast_sms/core'
+require 'codec_fast_sms/client'
+module CodecFastSms
+  class Error < StandardError; end
+  class ProfileNotFound < Error; end
+  class InvalidExtension < Error; end
+  class NoProfilesWereFound < Error; end
+end

data/lib/codec_fast_sms/client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CodecFastSms
+  # Client
+  class Client < Core
+    # Api endpoint.
+    def request_uri
+      '/FastApi.asmx/SendSms'
+    end
+
+    def params
+      {
+        userName: ::CodecFastSms.configuration(profile).username,
+        password: ::CodecFastSms.configuration(profile).password,
+        sender: ::CodecFastSms.configuration(profile).sender,
+        phone: to, messageContent: message, msgSpecialId: '', isOtn: 'True',
+        headerCode: '', responseType: '3', optionalParameters: ''
+      }
+    end
+
+    def assign_recipient_information(to, message)
+      self.to = to
+      self.message = message
+    end
+
+    def deliver(to, message)
+      assign_recipient_information(to, message)
+      perform
+    end
+  end
+end

data/lib/codec_fast_sms/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# main module
+module CodecFastSms
+  class << self
+    attr_accessor :configurations
+
+    def configuration(profile = :default)
+      raise NoProfilesWereFound if configurations.nil? || configurations.empty?
+
+      configurations.select do |conf|
+        conf.profile == profile
+      end.first || raise(ProfileNotFound, "Undefined profile: #{profile}")
+    end
+
+    private
+
+    def reject_profile(profile)
+      configurations.reject! { |conf| conf.profile == profile }
+    end
+
+    def initialize_configuration
+      self.configurations = [] if configurations.nil?
+      Configuration.new
+    end
+
+    def after_configuration_events(conf, profile)
+      conf.profile = profile # FORCE!
+      reject_profile(profile)
+      configurations << conf
+    end
+  end
+
+  def self.configure(profile = :default)
+    conf = initialize_configuration
+    yield(conf)
+    after_configuration_events(conf, profile)
+  end
+
+  # Configuration class
+  class Configuration
+    EXTENSION_TYPES = %w[yml json].freeze
+
+    attr_accessor :profile, :api_host, :username, :password, :sender
+
+    def initialize
+      self.profile = :default
+    end
+  end
+end

data/lib/codec_fast_sms/core.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CodecFastSms
+  # Core
+  class Core
+    attr_accessor :connection, :profile, :response, :to, :message
+    def initialize(profile: :default)
+      self.profile = profile
+      # Firstly, create a connection object.
+      self.connection = Faraday.new(
+        url: ::CodecFastSms.configuration(profile).api_host
+      )
+    end
+
+    # Call the api and process the response.
+    def perform
+      resp = connection.get(request_uri) do |req|
+        req.params = params
+      end
+      self.response = resp.body
+      # If server returns 200, everything is OK.
+      true
+    rescue Faraday::Error => e
+      self.response = { message: e.message }
+      false
+    end
+
+    def params; end
+  end
+end

data/lib/codec_fast_sms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodecFastSms
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: codec_fast_sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sertan Gülveren
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-30 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: It is a simple ruby client for Codec FastSMS API.
+email:
+- sertangulveren@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codec_fast_sms.gemspec
+- lib/codec_fast_sms.rb
+- lib/codec_fast_sms/client.rb
+- lib/codec_fast_sms/configuration.rb
+- lib/codec_fast_sms/core.rb
+- lib/codec_fast_sms/version.rb
+homepage: https://github.com/sertangulveren/codec_fast_sms
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sertangulveren/codec_fast_sms
+  source_code_uri: https://github.com/sertangulveren/codec_fast_sms
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Codec FastSMS Library for Ruby.
+test_files: []