apiwha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 520947b033c34f19330dccc9a66872130852a943a51665b8bc2419788bc48643
+  data.tar.gz: 427d0962b2b21f9f51b7c7ee7b6d7100e9dfdd7a399c1d154e457ba610420c40
+SHA512:
+  metadata.gz: 75a5e4d67f045f8888a157a86171ee57fb51ce77eedaab16cf21848a603cbec8c8499410563a0191706246df8c856418bfcd3b177d8c88146cdae278ee1591ea
+  data.tar.gz: f3325905e692fdeb5d5ef2763a30c99abab6840d16e9311b38488e1a46f66c20c64c78a66b77e275483a36abc27080d71aea9bc0682dcd952fb66711de52de9d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.3

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 davide.santangelo@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 apiwha.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    apiwha (0.1.0)
+      json (~> 2.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    vcr (3.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apiwha!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Davide Santangelo
+
+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,139 @@
+# Apiwha
+
+A tiny ruby wrapper around ApiWha API. If you want know more visit http://www.apiwha.com website.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apiwha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apiwha
+
+## Usage
+
+```ruby
+require 'apiwha'
+apiwha = Apiwha.new('Your secret API key')
+
+```
+Your secret API key. You can generate it in your dashboard from https://panel.apiwha.com/
+
+## Pull Messages
+
+Allows you to pull the messages you received and sent.
+
+### Options
+
+<b>type:</b> (Optional). Type of message to retrieve. Possible values: IN or OUT.
+
+<b>number:</b>  (Optional). Get IN or OUT messsages to or from this number.
+
+<b>markaspulled:</b>  (Optional). If you set this value in 1 you will mark your results as pulled.
+
+<b>getnotpulledonly:</b>  (Optional). If you set this value in 1 you will retrieve only results that you don't have marked as pulled. 
+
+<b>limit:</b>  (Default 100).
+
+<b>orderdesc:</b>  (Default most recent). If you set this value in 0 you will retrieve result from oldest to newest.
+
+```ruby
+messages = apiwha.pull_messages(options)
+```
+
+```
+[
+    { 
+      "id":"14409287",
+      "number":"391112223456",
+      "from":"391112223456",
+      "to":"39886677822",
+      "type":"IN",
+      "text":"test hello message",
+      "creation_date":"2019-03-11 14:29:51",
+      "process_date":"2019-03-11 14:29:51",
+      "failed_date":null,
+      "custom_data":null
+    },
+    
+    { 
+      "id":"14409219",
+      "number":"393938491113",
+      "from":"393891986619",
+      "to":"393938491113",
+      "type":"IN",
+      "text":"test message",
+      "creation_date":"2019-03-11 14:28:53",
+      "process_date":"2019-03-11 14:28:53",
+      "failed_date":null,
+      "custom_data":null
+    }
+]
+
+```
+
+
+## Send Message
+
+Allows you to send messages to any destination that wrote to you. 
+
+<b>number:</b> Destination number. Enter the number with country code. You can check the number formatting in https://faq.whatsapp.com/en/general/21016748
+
+<b>text:</b> Text of message to send or URL of media to send.
+
+<i>If this text is an URL that begins with "http" and finishes with ".png" or ".jpg" the system will send a picture.</i>
+
+<i>If this text is an URL that begins with "http" and finishes with ".ogg" the system will send an audio.</i>
+
+<i>If this text is an URL that begins with "http" and finishes with ".pdf" the system will send the pdf document.</i>
+
+<b>custom_data:</b> You can add your custom data in each message that you send. Then, you will receive this custom data by webhook events.
+
+
+```ruby
+apiwha.send_message(options)
+
+```
+
+## Get Credit
+
+Allows you to query about your credit
+
+```ruby
+credit = apiwha.get_credit
+
+```
+
+```
+{
+  "credit":45
+}
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/apiwha. 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 Apiwha project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apiwha/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/apiwha.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "apiwha/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "apiwha"
+  spec.version       = Apiwha::VERSION
+  spec.authors       = ["Davide Santangelo"]
+  spec.email         = ["davide.santangelo@gmail.com"]
+
+  spec.summary       = %q{A tiny ruby wrapper around ApiWha API}
+  spec.description   = %q{A tiny ruby wrapper around apiwha whatsapp API (https://apiwha.com)}
+  spec.homepage      = "https://github.com/davidesantangelo/apiwha"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/davidesantangelo/apiwha"
+    #spec.metadata["changelog_uri"] = "https://github.com/davidesantangelo/apiwha"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+
+  spec.required_ruby_version = ">= 2.3"
+
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "json", "~> 2.0"
+end

data/bin/console

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

@@ -0,0 +1,11 @@
+require "apiwha/version"
+require "apiwha/api"
+require "apiwha/error"
+
+module Apiwha
+  extend self
+
+  def new(api_key)
+    Api.new(api_key)
+  end
+end

data/lib/apiwha/api.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'rest-client'
+
+module Apiwha
+  class Api
+    API_URL = 'https://panel.apiwha.com'
+
+    DEFAULT_OPTIONS = {
+      number: nil,
+      type: nil, 
+      markaspulled: "0", 
+      getnotpulledonly: "0", 
+      limit: 100, 
+      orderdesc: "1"
+    }.freeze
+
+    attr_reader :api_key
+
+  	def initialize(api_key)
+  		@api_key = api_key
+  	end
+
+    def pull_messages(params: DEFAULT_OPTIONS)
+      response = RestClient.get("#{API_URL}/get_messages.php?apikey=#{@api_key}", { params: params })
+      response(response: response)
+    end
+
+    def send_message(text: , number: , custom_data: {})
+      payload = { 
+        text:  text, 
+        number: number, 
+        apikey: @api_key,
+        custom_data: custom_data.to_json
+      }
+  
+      response = RestClient.post "#{API_URL}/send_message.php?", payload
+
+      response(response: response)
+    end
+
+    def get_credit
+      response = RestClient.get("#{API_URL}/get_credit.php?apikey=#{@api_key}")
+      
+      response(response: response)
+    end
+
+    private
+
+    def response(response: )
+      return JSON.parse(response.body) if response.code.to_i == 200
+      
+      raise Error.new(response)
+    end
+  end
+end

data/lib/apiwha/error.rb

@@ -0,0 +1,15 @@
+module Apiwha
+  class Error < StandardError
+
+    attr_reader :reason
+
+    def initialize(response)
+      @reason = response
+    end
+
+    def message
+      "#{@reason}"
+    end
+    alias :to_s :message
+  end
+end

data/lib/apiwha/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: apiwha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Davide Santangelo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: vcr
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A tiny ruby wrapper around apiwha whatsapp API (https://apiwha.com)
+email:
+- davide.santangelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- apiwha.gemspec
+- bin/console
+- bin/setup
+- lib/apiwha.rb
+- lib/apiwha/api.rb
+- lib/apiwha/error.rb
+- lib/apiwha/version.rb
+homepage: https://github.com/davidesantangelo/apiwha
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/davidesantangelo/apiwha
+  source_code_uri: https://github.com/davidesantangelo/apiwha
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A tiny ruby wrapper around ApiWha API
+test_files: []