muthofun_api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f5b070a3efacdef1092f42cc7df8de2ef299188
+  data.tar.gz: c494dc0a6f79f6271bb89bbea7b622384fd5b70e
+SHA512:
+  metadata.gz: 391bfa858520603bb9793de24042c89bcddbdcb1fca4bc5ddfd2e38ba09e55e9ed5b74f906b1b9812a1f4541a521c9efb1dbdf0b6109ba85731a53e0189d1af1
+  data.tar.gz: 7269a72466ee88a64c8f8529add602051173372209751695659cde6dec3323ac642282c3c67ce37415b9fd3887b71bcd66a7661e7fd7490b77b577339648acbd

data/.gitignore

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

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 irfandhk@gmail.com. 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 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in muthofun_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    muthofun_api (0.1.0)
+      activesupport (~> 5.0)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  muthofun_api!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Irfan
+
+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,85 @@
+# MuthofunApi
+
+Welcome to MuthofunApi gem! Muthofun provides sms gateway to send sms.
+This rubygem will give you an easy interface to setup your muthofun account. And flexible
+way to send sms from your muthofun account!
+In order get sms please contact to Muthofun at +8801711272324
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'muthofun_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install muthofun_api
+
+## Usage
+
+##### Configuration:
+Steps to configure your `Muthofun` Sms Gateway!
+
+In config/initializers (for Ruby on Rails) file create a muthofun.rb file and configure your
+credentials. For other ruby based frameworks or raw ruby project, simply setup the configuration in
+any file.
+
+```ruby
+MuthofunApi.configuration do |config|
+  config.client_id  = 'abcdef'
+  config.secret_key = 'helloworld'
+  config.originator = '01844016400'
+end      
+```
+
+
+## How to send sms
+Once you are done with your credential setup you are ready to go
+you can send sms using the following command.
+
+```ruby
+result = MuthofunApi::SmsAccount.send_sms('8801766678130', 'Hello Bidhu from Irfan')
+pp result.output
+pp result.success?
+pp result.failed?
+pp result.error
+pp result.error_description
+pp result.error_code
+```
+But if you want to do something when sms is sent successfully you can use a block like the following snippets!
+
+```ruby
+a = MuthofunApi::SmsAccount.send_sms('8801766678130', 'Hello Bidhu from Irfan') do |result|
+  pp result.output
+  pp result.success?
+  pp result.failed?
+  pp result.error
+  pp result.error_description
+  pp result.error_code
+end
+```
+
+
+## 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/rubyrider/muthofun_api. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MuthofunApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/muthofun_api/blob/master/CODE_OF_CONDUCT.md).

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 "muthofun_api"
+
+# 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/muthofun_api.rb

@@ -0,0 +1,38 @@
+require 'pp'
+require 'faraday'
+require 'open-uri'
+require 'active_support/core_ext/hash/conversions'
+
+require "muthofun_api/version"
+require 'muthofun_api/configuration'
+require 'muthofun_api/errors/errors'
+require 'muthofun_api/sms_account'
+require 'muthofun_api/result'
+
+module MuthofunApi
+  class << self
+    attr_accessor :configuration
+  end
+  
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  def self.reset
+    @configuration = Configuration.new
+  end
+  
+  def self.configure
+    yield(configuration)
+
+    check_credentials!
+  end
+  
+  def self.check_credentials!
+    unless self.configuration.client_id && self.configuration.secret_key
+      raise Errors::CredentialMissing, 'Please provide api credential'
+    end
+    
+    true
+  end
+end

data/lib/muthofun_api/configuration.rb

@@ -0,0 +1,11 @@
+module MuthofunApi
+  class Configuration
+    attr_accessor :client_id, :secret_key, :originator
+    
+    def initialize
+      @client_id  = nil
+      @secret_key = nil
+      @originator = nil
+    end
+  end
+end

data/lib/muthofun_api/errors/errors.rb

@@ -0,0 +1,9 @@
+module MuthofunApi
+  module Errors
+    PhoneNumberNotProvided = Class.new(ArgumentError)
+    SMSContentNotProvided  = Class.new(ArgumentError)
+    AuthenticationError    = Class.new(StandardError)
+    CredentialMissing        = Class.new(StandardError)
+  end
+end
+

data/lib/muthofun_api/result.rb

@@ -0,0 +1,46 @@
+module MuthofunApi
+  class Result
+    def initialize(response)
+      @response = Hash.from_xml(response || '') || {smslist: {sms: {}, error: {}}}
+    end
+    
+    def output
+      @response.deep_symbolize_keys!
+    end
+    
+    def success?
+      !failed?
+    end
+    
+    def failed?
+      output[:smslist].present? && output[:smslist][:error].present?
+    end
+    
+    def sms_client_id
+      output[:smslist][:sms][:mobile_no] if success?
+    end
+    
+    def message_id
+      output[:smslist][:sms][:messageid] if success?
+    end
+    
+    def mobile
+      output[:smslist][:sms][:mobile_no] if success?
+    end
+    
+    def error_description
+      output[:smslist][:error][:error_description] if failed?
+    end
+    
+    def error_code
+      output[:smslist][:error][:error_code] if failed?
+    end
+    
+    def error
+      {
+          description: output[:smslist][:error][:error_description],
+          error_code:  output[:smslist][:error][:error_code]
+      }
+    end
+  end
+end

data/lib/muthofun_api/sms_account.rb

@@ -0,0 +1,44 @@
+module MuthofunApi
+  class SmsAccount
+    def self.send_sms(phone_number, body)
+      @sms_sender = self.new.send_sms(phone_number, body)
+    end
+    
+    def send_sms(phone_number, body)
+      request(path: 'sendsms.jsp', method: 'get', params: {'sms' => body, 'mobiles' => phone_number})
+      
+      @result = MuthofunApi::Result.new(response)
+      
+      yield(@result) if block_given? && @result.success?
+      
+      pp @result
+      
+      @result
+      
+    rescue => e
+      p e.message
+    end
+    
+    def response
+      @response
+    end
+    
+    private
+    
+    def request(path:, method: 'get', params: )
+      MuthofunApi.check_credentials!
+      
+      conn = ::Faraday.new(:url => "http://clients.muthofun.com:8901/esmsgw/#{path}")
+      
+      response = conn.send(method.to_sym) do |req|
+        req.params['user']     = MuthofunApi.configuration.client_id
+        req.params['password'] = MuthofunApi.configuration.secret_key
+        req.params['unicode']  = 1
+        req.params.merge!(params)
+        pp req.params
+      end
+      
+      @response = response.body.gsub(/[\r\n\t]+/m, "").strip
+    end
+  end
+end

data/lib/muthofun_api/version.rb

@@ -0,0 +1,3 @@
+module MuthofunApi
+  VERSION = "0.1.2"
+end

data/muthofun_api.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "muthofun_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "muthofun_api"
+  spec.version       = MuthofunApi::VERSION
+  spec.authors       = ["Irfan Ahmed"]
+  spec.email         = ["irfandhk@gmail.com"]
+
+  spec.summary       = %q{API for SMS Gateway for Muthofun (muthofun.com).}
+  spec.description   = %q{API to integrate SMS Gateway of Muthofun (muthofun)}
+  spec.homepage      = "https://github.com/rubyrider/muthofun_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: muthofun_api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Irfan Ahmed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API to integrate SMS Gateway of Muthofun (muthofun)
+email:
+- irfandhk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/muthofun_api.rb
+- lib/muthofun_api/configuration.rb
+- lib/muthofun_api/errors/errors.rb
+- lib/muthofun_api/result.rb
+- lib/muthofun_api/sms_account.rb
+- lib/muthofun_api/version.rb
+- muthofun_api-0.1.0.gem
+- muthofun_api.gemspec
+homepage: https://github.com/rubyrider/muthofun_api
+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.6.11
+signing_key: 
+specification_version: 4
+summary: API for SMS Gateway for Muthofun (muthofun.com).
+test_files: []