ongair_ruby 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9ad1fd414ce09dcd2c862aac5af857bbffd04f5
+  data.tar.gz: f93c6da90e22dc647a4151a254355bd7c23c5c42
+SHA512:
+  metadata.gz: 86accfce8ff23ec9b67c9c7a95b19baf33c90af54954f3c76d25f42ae3d637702a808efb5cad4d9b0f98c71bf0f8e033cc81814acca9e83dcff2f0a3df5aa485
+  data.tar.gz: b96ebbdcbc2f1851405bb2b649a5b1114ca07254281bf99755c29d630961b374934a7c2e7fee4f099f5170738ec50f11b7e4bfdf4e1830d5a5b64754bb1eb279

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 muaad
+
+MIT License
+
+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,67 @@
+# OngairRuby
+
+Ruby gem for using Ongair to to interact with WhatsApp; send messages, send media, add contacts, create groups, create lists, send broadcasts and many more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ongair_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ongair_ruby
+    
+Get the Ongair API key by signing up here: http://app.ongair.im
+
+## Usage
+
+        client = OngairRuby::ClientV2.new("YOUR_ONGAIR_API_KEY")
+        # Add a contact
+        client.create_contact("Name of contact", "254711223344")
+        
+        # Send a message
+        client.send_message("254711223344", "Hello")
+
+        # Send an image
+        client.send_image("254722123456", "http://domain.com/image.jpg")
+        
+## Coming soon
+        # List of contacts
+        client.contacts
+        
+        # Create a WhatsApp group
+        client.create_group("group_name", "group_type", "group_jid")
+        
+        # List of groups
+        client.groups
+        
+        # Create a distribution list
+        client.create_list("list_name", "list_description")
+        
+        # List of distribution lists
+        client.lists
+        
+        # Add contact to a distribution list
+        client.add_list_member(list_id, contact_id)
+        
+        # List of distribution list members
+        client.list_members(list_id)
+        
+        # remove contact from a distribution list
+        client.remove_list_member(list_id, contact_id)
+        
+        # send broadcasts to a distribution list
+        client.send_broadcast(list_id, "Hello everyone")
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ongair_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ongair_ruby.rb

@@ -0,0 +1,64 @@
+require "ongair_ruby/version"
+require "httparty"
+
+module OngairRuby
+  ONGAIR_URL = 'https://ongair.im'
+
+  class ClientV1
+  	def initialize token, base_url='https://ongair.im'
+  		@token = token
+      @base_url = base_url
+  	end
+
+  	def send_text_message(phone_number, message, thread=true, external_id=nil)
+  		response = HTTParty.post("#{@base_url}/api/v1/base/send", body: {token: @token, phone_number: phone_number, text: message, thread: thread, external_id: external_id })
+  	end
+
+    def send_image(phone_number, image_url, name, caption="", content_type='image/jpg', thread=true, external_id=nil)
+      response = HTTParty.post("#{@base_url}/api/v1/base/send_image", body: {token: @token, phone_number: phone_number, image: image_url, name: name, caption: caption, content_type: content_type, thread: thread, external_id: external_id })
+    end
+
+    def send_video(external_id, video_url, caption, thread=true)
+      response = HTTParty.post("#{@base_url}/api/v1/base/send_video", body: {token: @token, external_id: external_id, video_url: video_url, caption: caption, thread: thread})
+    end
+
+    def send_audio(external_id, audio_url, caption, thread=true)
+      response = HTTParty.post("#{@base_url}/api/v1/base/send_audio", body: {token: @token, external_id: external_id, audio_url: audio_url, caption: caption, thread: thread})
+    end
+  end
+
+  class ClientV2
+  	def initialize token, base_url='https://ongair.im'
+  		@token = token
+      @base_url = base_url
+  	end
+
+    def send_message(external_id, message, options=nil, thread=true)
+      HTTParty.post("#{@base_url}/api/v1/base/send", body: {token: @token, external_id: external_id, text: message, thread: thread, options: options })
+    end
+
+    def send_image(external_id, image_url, content_type, caption=nil, options=nil, thread=true)
+      HTTParty.post("#{@base_url}/api/v1/base/send_image", body: {token: @token, external_id: external_id, caption: caption, image: image_url, thread: thread, options: options })
+    end
+
+    ##
+    # Send a chain of messages including options
+    #
+    # @example
+    #
+    # messages=[{ text: 'Hi'}, { text: 'Question?', options: ["1,2"]} ]
+    def send_chain(external_id, messages, thread=true)
+      HTTParty.post("#{@base_url}/api/v1/base/send_chain", body: {token: @token, external_id: external_id, messages: messages, thread: thread })
+    end
+
+    def send_telephone_prompt(external_id, text, thread=true)
+      HTTParty.post("#{@base_url}/api/v1/base/send_telephone_prompt", body: {token: @token, external_id: external_id, text: text, thread: thread })
+    end
+
+    def send_location_prompt(external_id, text, thread=true)
+      HTTParty.post("#{@base_url}/api/v1/base/send_location_prompt", body: {token: @token, external_id: external_id, text: text, thread: thread })
+    end
+
+    
+  end
+end

data/lib/ongair_ruby/version.rb

@@ -0,0 +1,3 @@
+module OngairRuby
+  VERSION = "0.0.12"
+end

data/ongair_ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ongair_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ongair_ruby"
+  spec.version       = OngairRuby::VERSION
+  spec.authors       = ["Ongair Limited"]
+  spec.email         = ["hello@ongair.im"]
+  spec.summary       = %q{Ruby gem for Ongair.}
+  spec.description   = %q{Lets you use the Ongair API to interact with Messaging services like WhatsApp, WeChat and so on.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+end

data/spec/client_v1_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe OngairRuby::ClientV1 do
+
+  context 'Sending of messages' do
+    subject {
+      OngairRuby::ClientV1.new("auth_token")
+    }
+
+    it 'can send text messages' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send")
+        .with(body: "token=auth_token&phone_number=1&text=Hi&thread=true&external_id=1")
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_text_message('1', 'Hi', true, '1')
+      result = JSON.parse(response.body)
+
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send images' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_image")
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_image('1', 'https://google.com/1.jpg', '1.jpg', 'Testing', 'image/jpg', true, '1')
+      result = JSON.parse(response.body)
+
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send video' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_video")
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_video('1', 'https://google.com/1.avi', 'Testing',true)
+      result = JSON.parse(response.body)
+
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send audio' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_audio")
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_audio('1', 'https://google.com/1.avi', 'Testing',true)
+      result = JSON.parse(response.body)
+
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+  end
+end

data/spec/client_v2_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe OngairRuby::ClientV2 do
+
+  context 'Sending of messages' do
+    subject {
+      OngairRuby::ClientV2.new("auth_token")
+    }
+
+    it 'Can send a message' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send")
+        .with(
+          body: "token=auth_token&external_id=1&text=Hello&thread=true&options=1%2C2"
+        )
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_message('1', 'Hello', "1,2", true)
+      result = JSON.parse(response.body)
+
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'Can send an image' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_image")
+        .with(
+          body: "token=auth_token&external_id=1&caption=Hi&image=https%3A%2F%2Fimage.jpg&thread=true&options=1%2C2",
+          headers: {
+           'Accept'=>'*/*',
+          })
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_image('1', 'https://image.jpg', 'image/jpeg', 'Hi', "1,2", true)
+      result = JSON.parse(response.body)
+
+      expect(stub).to have_been_made
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send a chain with options' do
+
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_chain")
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_chain('1', [{ :text => "Hi"}, { :text => "You good?", :options => ["Yes", "No" ]}])
+      result = JSON.parse(response.body)
+
+      expect(stub).to have_been_made
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send a telephone number prompt' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_telephone_prompt")
+        .with(
+          body: "token=auth_token&external_id=1&text=Hi&thread=true"
+        )
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+
+      response = subject.send_telephone_prompt('1', "Hi")
+      result = JSON.parse(response.body)
+
+      expect(stub).to have_been_made
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+
+    it 'can send a location prompt' do
+      stub = stub_request(:post, "#{OngairRuby::ONGAIR_URL}/api/v1/base/send_location_prompt")
+        .with(
+          body: "token=auth_token&external_id=1&text=Hi&thread=true"
+        )
+        .to_return(status: 200, :body => {sent: true, id: 1}.to_json)
+
+      response = subject.send_location_prompt('1', "Hi")
+      result = JSON.parse(response.body)
+
+      expect(stub).to have_been_made
+      expect(result['sent']).to be true
+      expect(result['id']).to eql(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'webmock/rspec'
+require 'rspec'
+require 'ongair_ruby'
+
+WebMock.disable_net_connect!
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ongair_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Ongair Limited
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Lets you use the Ongair API to interact with Messaging services like
+  WhatsApp, WeChat and so on.
+email:
+- hello@ongair.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ongair_ruby.rb
+- lib/ongair_ruby/version.rb
+- ongair_ruby.gemspec
+- spec/client_v1_spec.rb
+- spec/client_v2_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Ruby gem for Ongair.
+test_files:
+- spec/client_v1_spec.rb
+- spec/client_v2_spec.rb
+- spec/spec_helper.rb