ozonetel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae5849da7d4c3324af27d91089b4cb0a350eb1c7
+  data.tar.gz: 60be30c3c7130d00eaf303477bad860a8bb2d211
+SHA512:
+  metadata.gz: 5b23307d39646f277e8d0ee051a54642f19f47894042822705be6be916edd71a8e67c3dd444b58e6bfd6932dd6d98bc909f843a9ef62a85262db6b892c1c2095
+  data.tar.gz: 94d3acdb6d4c0d31098dd8e2d578bc1d2656124346632c226069137473b7e4942e2f3304310c72e53eaaeca86c9602cfd45922116e729d8ba0aead86178b3a65

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ozonetel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aashutosh Chaudhary
+
+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,68 @@
+# Ozonetel - REST API to interact with Ozonetel KooKoo
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ozonetel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ozonetel
+
+## Usage
+
+ **Configure authentication key and version**
+
+  Add following lines into your rails application.rb file
+
+  Ozonetel.configure do |c|
+    c.outbound_version = 2
+    c.api_key = 'xxxxxxxxxxxxxxx'
+  end
+
+ **To send outbound call**
+
+ response = Ozonetel::Outbound::Call.connect({:phone_no => 'The phone number to place the call to', :extra_data => 'Your KooKoo Tunes', :caller_id => 'Your ozonetel caller id', :url => 'Your application url', :callback_url => 'URL which will be called after the call is finished.'})
+
+ Example - 1
+ response = Ozonetel::Outbound::Call.connect({:phone_no => "xxxxxxxxxx", :extra_data =>"<response><playtext>ILove KooKoo</playtext><hangup/></response>"})
+
+ puts response.status
+
+ "queued"
+
+ puts response.message
+
+ "136989181721681"
+
+ Example 2 -
+ response = Ozonetel::Outbound::Call.connect({:phone_no => "9643919931", :extra_data =>"<response><playtext>ILove KooKoo</playtext><hangup/></response>"})
+
+ puts response.status
+
+ "error"
+
+ puts response.message
+
+ "Authentication error"
+
+## Dependencies
+
+ gem httparty 0.14.0
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashugodia/ozonetel.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,9 @@
+require 'httparty'
+require "ozonetel/version"
+require "ozonetel/outbound/call"
+require "ozonetel/config"
+require "ozonetel/response"
+
+module Ozonetel
+  # Your code goes here...
+end

data/lib/ozonetel/config.rb

@@ -0,0 +1,15 @@
+module Ozonetel
+  class << self
+    attr_accessor :outbound_version, :api_key
+    
+    def configure
+      yield self
+    end
+  end  
+  
+  class AuthenticationError < StandardError;  end
+
+  class UnexpectedError < StandardError;  end
+
+  class ParamsError < StandardError;  end
+end

data/lib/ozonetel/outbound/call.rb

@@ -0,0 +1,56 @@
+require 'httparty'
+module Ozonetel
+  module Outbound
+    class Call
+      include HTTParty
+      
+      base_uri 'http://www.kookoo.in/outbound/outbound.php'
+      
+      def initialize; end
+      
+      def self.connect(params={})
+        self.new.connect(params)
+      end
+      
+      def connect(params={})
+        params = params.merge(configuration)
+        if valid?(params)
+          response = self.class.get(URI.escape("?#{transform_params(params)}"))
+          handle_response(response)
+        end
+      end
+      
+      protected
+      
+      def valid?(params)
+        mandatory_keys = [:phone_no, :api_key]
+        unless mandatory_keys.all?{|key| params.keys.include?(key)}
+          raise Ozonetel::ParamsError, "#{key} parameter missing." 
+        else
+          return true
+        end
+      end
+      
+      def transform_params(params)
+        transformed_params = []
+        params.each do |k,v| transformed_params << "#{k}=#{v}" end
+        transformed_params.join('&')
+      end
+      
+      def configuration
+        {:outbound_version => Ozonetel.outbound_version, :api_key => Ozonetel.api_key}
+      end
+      
+      def handle_response(response)
+        case response.code.to_i
+        when 200...300 then Ozonetel::Response.new(response)
+        when 401 then raise Ozonetel::AuthenticationError, response.body 
+        when 403 then Ozonetel::Response.new(response)
+        else
+          raise Ozonetel::UnexpectedError, response.body
+        end
+      end
+      
+    end
+  end
+end

data/lib/ozonetel/response.rb

@@ -0,0 +1,20 @@
+module Ozonetel
+  class Response
+    
+    def initialize(response)
+      set_response_data(response.parsed_response)
+    end
+    
+    def set_response_data(response)
+      (response['response']).each do |key, value|
+        set_variable(key, value)
+      end
+    end
+    
+    def set_variable(key, value)
+      self.class.send(:attr_accessor, key) #Set accessors dynamically
+      instance_variable_set("@#{key}", value)
+    end
+  end
+end
+

data/lib/ozonetel/version.rb

@@ -0,0 +1,3 @@
+module Ozonetel
+  VERSION = "0.1.0"
+end

data/ozonetel.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ozonetel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ozonetel"
+  spec.version       = Ozonetel::VERSION
+  spec.authors       = ["Aashutosh Chaudhary"]
+  spec.email         = ["ashugodia@gmail.com"]
+
+  spec.summary       = %q{REST API to interact with Ozonetel KooKoo.}
+  spec.description   = %q{This gem helps to make outbound calls using KooKoo.}
+  spec.homepage      = "https://github.com/ashugodia/ozonetel"
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'httparty', "~> 0.14.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ozonetel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aashutosh Chaudhary
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: This gem helps to make outbound calls using KooKoo.
+email:
+- ashugodia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ozonetel.rb
+- lib/ozonetel/config.rb
+- lib/ozonetel/outbound/call.rb
+- lib/ozonetel/response.rb
+- lib/ozonetel/version.rb
+- ozonetel.gemspec
+homepage: https://github.com/ashugodia/ozonetel
+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.4.8
+signing_key: 
+specification_version: 4
+summary: REST API to interact with Ozonetel KooKoo.
+test_files: []