beeiq_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 649c9f1f558edda455bbfe8e7d77ea486aae492f
+  data.tar.gz: 2748537350476a7afe4e4d64c3c97af72c264893
+SHA512:
+  metadata.gz: 77b9eaf32121895f500822ee9534b18eacaf40391506d637b217468f54c8f24bf9feea7113a020b4509599b05ce29d4073fddd6ff6033ec776bd7c51188dece4
+  data.tar.gz: 229fc90ad84859d2d7d36dbbad4eb76f37d63d2c0b8727d4c60f59906394166299498cd68d89a2a5d62d2224bfa739501908d281aa682c64d3d04bf0de6a46f2

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.4.2
+before_install: gem install bundler -v 2.0.1

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 huyhung1994@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in beeiq_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    beeiq_api (0.1.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    netrc (0.11.0)
+    public_suffix (3.0.3)
+    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)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beeiq_api!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Huy Hùng
+
+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,75 @@
+## Beeiq
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beeiq_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beeiq_api
+
+## Usage
+
+#### Configuration
+
+**Ruby**
+```ruby
+client = BeeiqAPI::Client.new(webhook_url, sender_email)
+```
+
+**Rails**
+```ruby
+# in file: config/initialize/beeiq.rb
+BeeiqAPI.configure do |config|
+  config.webhook_url = 'https://github.com'
+  config.sender_email = 'huyhung1994@gmail.com'
+end
+
+client = BeeiqAPI::Client.new
+```
+
+#### **Create ticket**
+Create ticket and create contact/lead
+```ruby
+data = {
+  # ticket info
+  title: 'title of ticket',
+  body: 'body of ticket', # required
+  tag: 'webhook',
+
+  # for create contact/lead
+  contact_type: 'customer', # [lead, customer] default is customer
+  name: 'name of contact',
+  email: 'email@github.com',
+  phone: '01234567890'
+}
+
+client.create_ticket(data)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hungdh0x5e/beeiq. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Beeiq project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hungdh0x5e/beeiq/blob/master/CODE_OF_CONDUCT.md).
+
+## TODO:
+
+- [x] add-ticket: thêm Ticket
+- [ ] add-contact: tạo Contact
+- [ ] update-contact: cập nhật Contact
+- [ ] add-note: thêm Ghi chú

data/Rakefile

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

data/beeiq_api.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "beeiq_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "beeiq_api"
+  spec.version       = BeeiqAPI::VERSION
+  spec.authors       = ["Huy Hùng"]
+  spec.email         = ["huyhung1994@gmail.com"]
+
+  spec.summary       = "BeeIQ REST API Client"
+  spec.description   = "Ruby wrapper for the REST API at https://www.beeiq.com. Documentation at https://guide.antbuddy.com/kb/instructions-to-enter-data-into-beeiq-data-platform"
+  spec.homepage      = "https://github.com/hungdh0x5e/beeiq_api"
+  spec.license       = "MIT"
+
+  # 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 "webmock", "~> 3.5"
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
+end

data/bin/console

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

@@ -0,0 +1,51 @@
+module BeeiqAPI
+  module Config
+    module ActionType
+      ADD_CONTACT = 'add-contact'.freeze
+      UPDATE_CONTACT = 'update-contact'.freeze
+      ADD_NOTE = 'add-note'.freeze
+      ADD_DEAL = 'add-deal'.freeze
+      ADD_TICKET = 'add-ticket'.freeze
+    end
+
+    module ContactType
+      LEAD = 'lead'.freeze
+      CUSTOMER = 'customer'.freeze
+    end
+
+    module Gender
+      MALE = 0
+      FEMALE = 1
+      OTHER = 2
+    end
+
+    module EmailType
+      WORK = 'Work'.freeze
+      HOME = 'Home'.freeze
+      MOBILE = 'Mobile'.freeze
+      OTHER = 'Other'.freeze
+    end
+
+    module PhoneType
+      WORK = 'Work'.freeze
+      HOME = 'Home'.freeze
+      MOBILE = 'Mobile'.freeze
+      OTHER = 'Other'.freeze
+    end
+
+    module AddressType
+      WORK = 'Work'.freeze
+      HOME = 'Home'.freeze
+      OTHER = 'Other'.freeze
+    end
+
+    module ImType
+      SKYPE = 'Skype'.freeze
+      FACEBOOK = 'Facebook'.freeze
+      YAHOO = 'Yahoo'.freeze
+      VIBER = 'Viber'.freeze
+      HANGOUTS = 'Hangouts'.freeze
+      OTHER = 'Other'.freeze
+    end
+  end
+end

data/lib/beeiq_api/response.rb

@@ -0,0 +1,47 @@
+module BeeiqAPI
+  class Response
+    attr_accessor :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def body
+      if success?
+        { success: true }
+      else
+        format_hash(JSON.parse(response.body, :quirks_mode => true))
+      end
+    end
+
+    def raw_body
+      response.body
+    end
+
+    def success?
+      [200, 204].include? response.code
+    end
+
+    def code
+      response.code
+    end
+
+    def headers
+      response.headers
+    end
+
+    private
+
+    def format_hash(h)
+      if h.kind_of? Hash
+        Hash[
+          h.map do |k, v|
+            [k.respond_to?(:to_sym) ? k.to_sym : k, format_hash(v)]
+          end
+        ]
+      else
+        h
+      end
+    end
+  end
+end

data/lib/beeiq_api/ticket.rb

@@ -0,0 +1,51 @@
+module BeeiqAPI
+  class Ticket
+    attr_accessor :contact_type
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :email
+    attr_accessor :phone
+    attr_accessor :name
+    attr_accessor :passport
+    attr_accessor :contact_id
+    attr_accessor :group_name
+    attr_accessor :sla_name
+    attr_accessor :channel
+    attr_accessor :tag
+
+    def initialize(options = {})
+      @contactType = options[:contact_type] || Config::ContactType::CUSTOMER
+      @title = options[:title]
+      @body = options[:body]
+      @email = options[:email]
+      @phone = options[:phone]
+      @name = options[:name]
+      @passport = options[:passport]
+      @contact_id = options[:contact_id]
+      @group_name = options[:group_name]
+      @sla_name = options[:sla_name]
+      @channel = options[:channel]
+      @tag = options[:tag]
+
+      raise ArgumentError, 'body is required' if @body.to_s.empty?
+    end
+
+    def payload
+      data = {
+        contactType: @contact_type,
+        title: @title,
+        body: @body,
+        email: @email,
+        phone: @phone,
+        name: @name,
+        passport: @passport,
+        contactId: @contact_id,
+        groupName: @group_name,
+        slaName: @sla_name,
+        channel: @channel,
+        tag: @tag
+      }
+      data.delete_if { |k, v| v.nil? || v.empty? }
+    end
+  end
+end

data/lib/beeiq_api/version.rb

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

data/lib/beeiq_api.rb

@@ -0,0 +1,73 @@
+require "beeiq_api/version"
+require "beeiq_api/config"
+require "beeiq_api/response"
+require "beeiq_api/ticket"
+require 'configuration'
+require 'rest-client'
+require 'json'
+
+module BeeiqAPI
+  class Error < StandardError; end
+
+  class Client
+    attr_reader :webhook_url
+    attr_reader :sender_email
+
+    def initialize(webhook_url = nil, sender_email = nil)
+      webhook_url ||= BeeiqAPI.configuration.webhook_url
+      sender_email ||= BeeiqAPI.configuration.sender_email
+
+      raise ArgumentError, 'Missing webhook url' if webhook_url.to_s.empty?
+      raise ArgumentError, 'Missing sender_email' if sender_email.to_s.empty?
+
+      @webhook_url = webhook_url
+      @sender_email = sender_email
+    end
+
+    def create_ticket(data = {})
+      create_many_ticket([data])
+    end
+
+    def create_many_ticket(data = [])
+      payload = build_payload(Config::ActionType::ADD_TICKET, data)
+      process(:post, payload)
+    end
+
+    def build_payload(action, data)
+      payload =
+        case action
+        when Config::ActionType::ADD_TICKET
+          build_ticket_payload(data)
+        end
+
+      {
+        senderUser: @sender_email,
+        data: payload
+      }
+    end
+
+    def build_ticket_payload(data)
+      data.map do |item|
+        ticket = BeeiqAPI::Ticket.new item
+        {
+          actionType: Config::ActionType::ADD_TICKET,
+          data: ticket.payload
+        }
+      end
+    end
+
+    private
+
+    def process(verb, data=nil)
+      begin
+        BeeiqAPI::Response.new ::RestClient::Request.execute(method: verb,
+                                  url: @webhook_url,
+                                  headers: { 'Content-Type': 'application/json' },
+                                  payload: data.to_json,
+                                  timeout: 10)
+      rescue ::RestClient::ExceptionWithResponse => e
+        BeeiqAPI::Response.new e.response
+      end
+    end
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,22 @@
+module BeeiqAPI
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    # The API key for your project.
+    attr_accessor :webhook_url
+    # The email sender in BeeIQ platform
+    attr_accessor :sender_email
+
+    def initialize
+      @webhook_url= nil
+      @sender_email = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: beeiq_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Huy Hùng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-26 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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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'
+description: Ruby wrapper for the REST API at https://www.beeiq.com. Documentation
+  at https://guide.antbuddy.com/kb/instructions-to-enter-data-into-beeiq-data-platform
+email:
+- huyhung1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- beeiq_api.gemspec
+- bin/console
+- bin/setup
+- lib/beeiq_api.rb
+- lib/beeiq_api/config.rb
+- lib/beeiq_api/response.rb
+- lib/beeiq_api/ticket.rb
+- lib/beeiq_api/version.rb
+- lib/configuration.rb
+homepage: https://github.com/hungdh0x5e/beeiq_api
+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.13
+signing_key: 
+specification_version: 4
+summary: BeeIQ REST API Client
+test_files: []