didww-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8856f75481da588975f5012ddad226b67cd2315ed8789c091d43082c987076f0
+  data.tar.gz: 94dc4b0f6c392f8abc3bf6bf2db9e32f8943ab286d4b22d7c169dae5e7f82282
+SHA512:
+  metadata.gz: a14c32e51d333ac7105f9203c9cc933648a4fa8f663bc6450013e936445c9582b767542333eef8d00af206f9843b8b9aeb9b6d5dd2c34eef1f1a67339d67c201
+  data.tar.gz: cbeef34e7011139f67d6c8173f438bf2d62a97338dc441ce19aed3e58071f472e5db948ccd2013349f2bfba0dd9f2d167bdac7f14c9ad011de8a81d83e56ccf1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/DIDWW.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'DIDWW/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "DIDWW"
+  spec.version       = DIDWW::VERSION
+  spec.authors       = ["Julien Chabanon"]
+  spec.email         = ["julien.chabanon@modulis.ca"]
+  spec.summary       = %q{A simple API wrapper for DIDWW SOAP API}
+  spec.description   = %q{This API wrapper is meant to provide a rails friendly configurable api wrapper to access DIDWW's SOAP based API using Savon gem.}
+  spec.homepage      = "http://github.com/modulis/DIDWW-API-WRAPPER"
+  spec.license       = "MIT"
+
+  spec.name          = "didww-client"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.version       = DIDWW::VERSION
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "savon", "~> 2.11.1"
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in DIDWW.gemspec
+gemspec
+
+gem 'savon'
+gem 'pry-byebug'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Luke Jones
+
+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,81 @@
+# DIDWW
+
+A simple Rails friendly API wrapper for DIDWW's SOAP based API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'DIDWW', git: 'https://github.com/modulis/DIDWW-API-WRAPPER.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install DIDWW
+
+## Usage
+### Configuration
+First you must configure DIDWW or you won't be able to make requests.
+```ruby
+DIDWW.configure do |config|
+  config.api_username = 'user@user.ca' # Your api username given to you by didww
+  config.api_key = 'example_key_u90sd8f7sd9' # Your secret api key given to you by didww
+  config.sandbox = false # Optional. True by default, you must set it to live manually.
+end
+```
+
+For secret information like your `api_key` it's recommended that you use something like environment variables. For example:
+```ruby
+DIDWW.configure do |config|
+  config.api_key = ENV['DIDWW_API_KEY']
+end
+```
+
+### Building the client
+You can create a client which will inheret DIDWW configuration automatically using
+```ruby
+client = DIDWW::Client.new
+```
+
+If you would like to change the configuration for a specific client you'll have to do so manually:
+```ruby
+client.configuration.sandbox = false # sets this client to live mode
+```
+
+### Making calls
+A list of methods can be seen in `METHOD_TRANSLATIONS` in the client class in the source code. Making a call is as easy as:
+```ruby
+client = DIDWW::Client.new
+client.check_pstn_number(pstn_number: 1111111)
+```
+
+### Convenience methods
+DIDWW has a few convenience methods to use in your code:
+```ruby
+DIDWW.configure do |config|
+  config.sandbox = true
+end
+DIDWW.sandbox? #=> true
+DIDWW.live? #=> false
+DIDWW.mode #=> :sandbox (alternatively :live)
+```
+
+## Development
+
+You have access to a developer console to use the gem interactively by running `bin/console` from the project directory.
+Please write specs for any additions, and use shared examples when possible.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/DIDWW.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "DIDWW"
+
+# 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.
+
+require "pry"
+Pry.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/DIDWW.rb

@@ -0,0 +1,33 @@
+require "DIDWW/version"
+require "DIDWW/configuration"
+require 'DIDWW/client'
+
+module DIDWW
+  class << self
+    attr_reader :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.mode
+    configuration.sandbox ? :sandbox : :live
+  end
+
+  def self.sandbox?
+    configuration.sandbox
+  end
+
+  def self.live?
+    !configuration.sandbox
+  end
+end

data/lib/DIDWW/client.rb

@@ -0,0 +1,79 @@
+require 'savon'
+
+module DIDWW
+  class Client
+    attr_reader :configuration, :methods
+
+    # key is method used by this api wrapper,
+    # value is method used by DIDWW's SOAP api
+    METHOD_TRANSLATIONS = {
+      get_invoices: :didww_callhistory_invoices,
+      check_pstn_number: :didww_checkpstnnumber,
+      restore_did: :didww_didrestore,
+      get_cdr_log: :didww_getcdrlog,
+      get_coverage: :didww_getcoverage,
+      get_api_details: :didww_getdidwwapidetails,
+      get_cities: :didww_getdidwwcities,
+      get_countries: :didww_getdidwwcountries,
+      get_pstn_rates: :didww_getdidwwpstnrates,
+      get_regions: :didww_getdidwwregions,
+      get_prepaid_balance: :didww_getprepaidbalance,
+      get_prepaid_balances: :didww_getprepaidbalancelist,
+      get_service_details: :didww_getservicedetails,
+      get_service_list: :didww_getservicelist,
+      get_sms_log: :didww_getsmslog,
+      auto_renew_status: :didww_order_autorenew_status,
+      auto_renew: :didww_orderautorenew,
+      cancel_order: :didww_ordercancel,
+      create_order: :didww_ordercreate,
+      get_pstn_traffic_data: :didww_pstn_traffic,
+      update_mapping: :didww_updatemapping,
+      update_prepaid_balance: :didww_updateprepaidbalance,
+      update_pstn_rates: :didww_updatepstnrates
+    }.freeze
+
+    UNIQUE_HASH_METHODS = [
+      :create_order,
+      :auto_renew,
+      :update_prepaid_balance,
+      :restore_did
+    ].freeze
+
+    def initialize
+      @configuration = DIDWW.configuration
+      @savon = savon_client
+      @methods = METHOD_TRANSLATIONS.keys
+    end
+
+    def method_missing(method_name, *args, &block)
+      if methods.include? method_name
+        params = (args.first || {}).merge(auth_string: auth_string)
+        params.merge!(uniq_hash: (Time.now.to_i.to_s + auth_string)) if UNIQUE_HASH_METHODS.include?(method_name)
+        @savon.call METHOD_TRANSLATIONS[method_name], message: params
+      else
+        raise NoMethodError, "#{method_name} is not a valid api endpoint!"
+      end
+    end
+
+    private
+
+    def savon_client
+      wsdl = configuration.sandbox ? sandbox_url : live_url
+      Savon::Client.new wsdl: wsdl
+    end
+
+    def auth_string
+      string = configuration.api_username + configuration.api_key
+      string += 'sandbox' if configuration.sandbox
+      Digest::SHA1.hexdigest(string)
+    end
+
+    def sandbox_url
+      'https://sandbox-api.didww.com/api2/index.php?wsdl'
+    end
+
+    def live_url
+      'https://api.didww.com/api2/?wsdl'
+    end
+  end
+end

data/lib/DIDWW/configuration.rb

@@ -0,0 +1,11 @@
+module DIDWW
+  class Configuration
+    attr_accessor :api_username, :api_key, :sandbox
+
+    def initialize(params = {})
+      @api_username = params[:api_username]
+      @api_key = params[:api_key]
+      @sandbox = params[:sandbox] || true
+    end
+  end
+end

data/lib/DIDWW/version.rb

@@ -0,0 +1,3 @@
+module DIDWW
+  VERSION = "0.1.1"
+end

data/spec/DIDWW/Client_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'DIDWW/client'
+
+describe DIDWW::Client do
+  let(:client) { described_class.new }
+
+  before(:each) do
+    allow(Savon::Client).to receive(:new).and_return(dummy_client)
+    allow(dummy_client).to receive(:call)
+  end
+
+  let(:dummy_client) { instance_double Savon::Client }
+
+  describe '#method_missing' do
+    context "when the method is not a valid api endpoint" do
+      subject { client.foo }
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(NoMethodError)
+      end
+    end
+
+    context "when the method is a valid api endpoint" do
+      subject { client.auto_renew_status(customer_id: 0, did: 1111111111) }
+
+      it "calls the api" do
+        expect(dummy_client).to receive(:call)
+        subject
+      end
+    end
+  end
+end

data/spec/DIDWW_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe DIDWW do
+  it 'has a version number' do
+    expect(DIDWW::VERSION).not_to be nil
+  end
+
+  describe '.configure' do
+    subject do
+      described_class.configure do |config|
+        config.api_username = 'test@test.ca'
+        config.api_key = 'test_key'
+        config.sandbox = false
+      end
+    end
+
+    it "changes the configuration" do
+      subject
+      expect(described_class.configuration.api_username).to eq 'test@test.ca'
+      expect(described_class.configuration.api_key).to eq 'test_key'
+      expect(described_class.configuration.sandbox).to be false
+    end
+  end
+
+  describe '.reset' do
+    subject { described_class.reset }
+
+    before(:each) do
+      described_class.configuration.api_key = 'test_key'
+    end
+
+    it "resets the configuration" do
+      subject
+      expect(described_class.configuration.api_key).not_to eq 'test_key'
+    end
+  end
+
+  describe '.mode' do
+    subject { described_class.mode }
+
+    context "when sandbox is set to true" do
+      before(:each) do
+        described_class.configuration.sandbox = true
+      end
+
+      it "returns :sandbox" do
+        expect(subject).to eq :sandbox
+      end
+    end
+
+    context "when sandbox is set to false" do
+      before(:each) do
+        described_class.configuration.sandbox = false
+      end
+
+      it "returns :live" do
+        expect(subject).to eq :live
+      end
+    end
+  end
+
+  describe '.sandbox?' do
+    subject { described_class.sandbox? }
+
+    context "when in sandbox mode" do
+      before(:each) do
+        described_class.configuration.sandbox = true
+      end
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+
+    context "when not in sandbox mode" do
+      before(:each) do
+        described_class.configuration.sandbox = false
+      end
+
+      it "returns false" do
+        expect(subject).to be false
+      end
+    end
+  end
+
+  describe '.live?' do
+    subject { described_class.live? }
+
+    context "when in sandbox mode" do
+      before(:each) do
+        described_class.configuration.sandbox = true
+      end
+
+      it "returns false" do
+        expect(subject).to be false
+      end
+    end
+
+    context "when not in sandbox mode" do
+      before(:each) do
+        described_class.configuration.sandbox = false
+      end
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'DIDWW'
+require 'bundler/setup'
+require 'pry'
+
+DIDWW.configure do |config|
+  config.api_username = 'test@test.ca'
+  config.api_key = 'test_key'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: didww-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julien Chabanon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-10 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: 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: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+description: This API wrapper is meant to provide a rails friendly configurable api
+  wrapper to access DIDWW's SOAP based API using Savon gem.
+email:
+- julien.chabanon@modulis.ca
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- DIDWW.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/DIDWW.rb
+- lib/DIDWW/client.rb
+- lib/DIDWW/configuration.rb
+- lib/DIDWW/version.rb
+- spec/DIDWW/Client_spec.rb
+- spec/DIDWW_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/modulis/DIDWW-API-WRAPPER
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple API wrapper for DIDWW SOAP API
+test_files: []