whathor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c62ee953137e715320ff127ce44a903a89f6188
+  data.tar.gz: 36ba8b5d6141ca0dcb54d55206b6cce15cdb0e20
+SHA512:
+  metadata.gz: f9710f9ac0ece7e50a4f6d7a3d98c94ca63234f7acae8226d43718be9c56b14e2ca6db6b1ff178122f1bddd0f52b9540e6398b70933badbbbb3f5e007fcf02ac
+  data.tar.gz: 30af6f21786a7319cfd866dd4e9abef72fef2a9bfb2ca691f3c7e5ab5c64fbfc2293441167da194438873f0e342ce37ae5931c10250d8bcb1663f8b3a109860b

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,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Larry Morales Jordan
+
+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,39 @@
+# Whathor
+
+Whathor allows you in an easy way to send Whatsapp messages directly from your ruby app by acting
+as a wrapper for Whatools Rest API. To be able to use this gem you have to register and
+get a token key from [https://wha.tools](https://wha.tools/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whathor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whathor
+
+## Usage
+
+There are only three easy steps for this to work:
+
+```ruby
+
+  # 1. Before any message is sent for the first time, you have to subscribe against Whatools Rest API
+  # by passing the token.
+  Whathor.subscribe "MY_WHATOOLS_TOKEN"
+
+  # 2. Sends a message to another whatsapp user by specifying the phone number prefixed with country code
+  # and body of the message.
+  Whathor.message to: '573001231231231', body: "This is cool! :)" # 57 = country code, 3001231231231 = Phone number
+
+  # 3. When you are done sending messages. Unsubscribe from Whatools so that further notifications and
+  # messages are not lost.
+  Whathor.unsubscribe
+```
+You can read more about Whatools API specification in [https://api.wha.tools/v0](https://api.wha.tools/v0/)

data/Rakefile

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

data/lib/whathor.rb

@@ -0,0 +1,26 @@
+require "whathor/version"
+require 'rest_client'
+
+module Whathor
+
+  def self.subscribe(token)
+    @token = token
+    resp = RestClient.get 'https://api.wha.tools/v0/subscribe', {params: {key: @token}} # => "{\"success\": true}"
+    JSON.parse(resp, symbolize_names: true)[:success]
+  end
+
+  def self.unsubscribe
+    return false if @token.nil?
+    resp = RestClient.get 'https://api.wha.tools/v0/unsubscribe', {params: {key: @token}} # => "{\"success\": true}"
+    JSON.parse(resp, symbolize_names: true)[:success]
+  end
+
+  def self.message(to: '', body: '')
+    raise ArgumentError.new("number of receiver\'s message is empty") unless !to.empty?
+    raise ArgumentError.new("body of message is empty") unless !body.empty?
+    return false if @token.nil?
+    resp = RestClient.post 'https://api.wha.tools/v0/message', key: @token, to: to, body: body, ack: true # => "{\"result\": \"0123456789-0\", \"success\": true}"
+    JSON.parse(resp, symbolize_names: true)[:success]
+  end
+
+end

data/lib/whathor/version.rb

@@ -0,0 +1,3 @@
+module Whathor
+  VERSION = "0.0.2"
+end

data/spec/lib/whathor_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+TOKEN = "a-s-u-b-s-c-r-i-p-t-i-o-n-t-o-k-e-n"
+
+RSpec.describe Whathor do
+
+  context "subscription with Whatools" do
+    it "subscribes an API Token with whatools" do
+      allow(RestClient).to receive_messages(get: "{\"success\":true}")
+      resp = Whathor.subscribe TOKEN
+      expect(resp).to be_truthy
+    end
+
+    it "returns false when API Token is bad" do
+      allow(RestClient).to receive_messages(get: "{\"success\":false}")
+      resp = Whathor.subscribe "BADWHATOOLSTOKEN"
+      expect(resp).to be_falsy
+    end
+
+    context "Given a subscription already exists" do
+      before do
+        allow(RestClient).to receive_messages(get: "{\"success\":true}")
+        Whathor.subscribe TOKEN
+      end
+      it "unsubscribes with whatools" do
+        resp = Whathor.unsubscribe
+        expect(resp).to be_truthy
+      end
+    end
+
+    it "returns false when no subscription was accomplished first" do
+      resp = Whathor.unsubscribe
+      expect(resp).to be_falsy
+    end
+  end
+
+  context "send messages" do
+    it "raises ArgumentError when :to param is empty" do
+      expect{
+        Whathor.message(to: '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "raises ArgumentError when :body param is empty" do
+      expect{
+        Whathor.message(to: '579876543210', body: '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "returns false if no subscription was previously performed" do
+      resp = Whathor.message(to: '579876543210', body: 'Hello :)')
+      expect(resp).to be_falsy
+    end
+
+    it "returns true when a message was successfully sent" do
+      allow(RestClient).to receive_messages(get: "{\"success\":true}", post: "{\"success\":true}")
+      Whathor.subscribe TOKEN
+      resp = Whathor.message(to: '001234567890', body: 'Hello :)')
+      expect(resp).to be_truthy
+      Whathor.unsubscribe
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'whathor'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/whathor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whathor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whathor"
+  spec.version       = Whathor::VERSION
+  spec.authors       = ["Larry Morales Jordan"]
+  spec.email         = ["larrymoralesjordan@gmail.com"]
+  spec.summary       = %q{Wraper gem for your app to be able to send whatsapp meesages.}
+  spec.description   = %q{Wraper gem fro whatools API. It helps you to send whatsapp messages from your ruby app.}
+  spec.homepage      = "https://github.com/larrymjordan/whathor"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", '~> 3'
+
+  spec.add_runtime_dependency "rest-client", "~> 1.8"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: whathor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Larry Morales Jordan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Wraper gem fro whatools API. It helps you to send whatsapp messages from
+  your ruby app.
+email:
+- larrymoralesjordan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/whathor.rb
+- lib/whathor/version.rb
+- spec/lib/whathor_spec.rb
+- spec/spec_helper.rb
+- whathor.gemspec
+homepage: https://github.com/larrymjordan/whathor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Wraper gem for your app to be able to send whatsapp meesages.
+test_files:
+- spec/lib/whathor_spec.rb
+- spec/spec_helper.rb