rubychy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 333bc5bc3aee4fc79a6d6b59708e2b3d385b5ddb
+  data.tar.gz: 8ee862e01cbcd6674b496db4baf2dc22038a86b1
+SHA512:
+  metadata.gz: 5c8339a59ab0946bc6956472fb38a0dbc616aa929bd311c31c7a7054938ca1da8e6227d79a2ee0998e3228ffe59f2ecabc1cefab1492250993a32536f59f5d05
+  data.tar.gz: fe1c6c9c0dba615116411fd26121d692f78fbae7982ddc4c1035bbb43f1301772eda2839ab3a52506ceb6003f8afc98857a0d6c350bee6f5414a9ad15411c3a1

data/.gitignore

@@ -0,0 +1,35 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nima Kaviani
+
+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,2 @@
+# rubychy
+A ruby bot client for Kik provided by [Robochy](http://robochy.com)

data/lib/rubychy/api_response.rb

@@ -0,0 +1,34 @@
+module Rubychy
+  class ApiResponse
+    attr_reader :body
+    attr_reader :result
+    attr_reader :success
+
+    def initialize(response,fail_silently = false)
+      if response.status < 500
+        @body = response.body
+        data = MultiJson.load(@body)
+        @success = (response.status == 200)
+
+        if @success
+          @result = data
+        else
+          if !fail_silently
+            fail Rubychy::Errors::BadRequestError.new(data['error'], data['message'])
+          end
+        end
+      else
+        if !fail_silently
+          fail Rubychy::Errors::ServiceUnavailableError.new(response.status)
+        end
+      end
+    end
+
+    def self.parse(request)
+      Rubychy::DataTypes::ReceivedMessages.new(MultiJson.load(request.body))
+    end
+
+    alias_method :success?, :success
+  end
+end
+

data/lib/rubychy/bot.rb

@@ -0,0 +1,94 @@
+module Rubychy
+  class Bot
+    API_ENDPOINT = 'https://api.kik.com/v1'
+
+    attr_reader :me
+
+    def initialize(username, api_token)
+      @username = username
+      @api_token = api_token
+      @offset = 0
+      @timeout = 60
+      @fail_silently = false
+      @connection = HTTPClient.new
+      @connection.set_auth(nil, @username, @api_token)
+    end
+
+    def config(webhook, features = Rubychy::DataTypes::Features.new)
+      api_post('config', {webhook: webhook, features: features})
+    end
+
+    def send_message(*messages)
+      msgs = { messages: sanitize('message', messages) }
+      api_post('message', msgs)
+    end
+
+    def get_user(username)
+      response = api_get("user/#{username}")
+      Rubychy::DataTypes::User.new(response.result)
+    end
+
+  private
+
+    def sanitize(action, messages)
+      validated_params = Array.new
+      messages.each do |message|
+        # Delete params not accepted by the API
+        validated_param = message.to_hash.delete_if { |k, _v|
+          !message.validations.key?(k) || (message.validations[k][:drop_empty] && _v.nil?)
+        }
+
+        # Check all required params by the action are present
+        message.validations.each do |key, _value|
+          if _value[:required] && (!validated_param.key?(key) || validated_param[key].nil?)
+            fail Rubychy::Errors::MissingParamsError.new(key, action)
+          end
+
+          # Check param types
+          unless _value[:class].include?(validated_param[key].class) || (_value[:drop_empty] && validated_param[key].nil?)
+            fail Rubychy::Errors::InvalidParamTypeError.new(key, validated_param[key].class, _value[:class])
+          end
+          validated_params[key] = validated_param[key].to_s if _value[:class] == Fixnum
+        end
+
+        validated_params << validated_param
+      end
+      return validated_params
+    end
+
+    def api_get(action)
+      api_uri = "#{action}"
+      begin
+        response = @connection.get(
+          "#{API_ENDPOINT}/#{api_uri}",
+          nil
+        )
+
+        ApiResponse.new(response,@fail_silently)
+      rescue HTTPClient::ReceiveTimeoutError => e
+        if !@fail_silently
+          fail Rubychy::Errors::TimeoutError, e.to_s
+        end
+      end
+    end
+
+    def api_post(action, params)
+      api_uri = "#{action}"
+
+      begin
+        response = @connection.post(
+          "#{API_ENDPOINT}/#{api_uri}",
+          MultiJson.dump(params),
+          'Content-Type' => 'application/json'
+        )
+
+        ApiResponse.new(response,@fail_silently)
+      rescue HTTPClient::ReceiveTimeoutError => e
+        if !@fail_silently
+          fail Rubychy::Errors::TimeoutError, e.to_s
+        end
+      end
+    end
+
+  end
+end

data/lib/rubychy/data_types/attribution.rb

@@ -0,0 +1,9 @@
+module Rubychy
+  module DataTypes
+    class Attribution < Rubychy::DataTypes::Base
+      attribute :name, String
+      attribute :iconUrl, String
+    end
+  end
+end
+

data/lib/rubychy/data_types/base.rb

@@ -0,0 +1,7 @@
+module Rubychy
+  module DataTypes
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/rubychy/data_types/features.rb

@@ -0,0 +1,11 @@
+module Rubychy
+  module DataTypes
+    class Features < Rubychy::DataTypes::Base
+      attribute :manuallySendReadReceipts, Boolean, :default => false
+      attribute :receiveReadReceipts, Boolean, :default => false
+      attribute :receiveDeliveryReceipts, Boolean, :default => false
+      attribute :receiveIsTyping, Boolean, :default => false
+    end
+  end
+end
+

data/lib/rubychy/data_types/keyboard.rb

@@ -0,0 +1,22 @@
+module Rubychy
+  module DataTypes
+    class Keyboard < Rubychy::DataTypes::Base
+      attribute :type, String, :default => "suggested"
+      attribute :to, String
+      attribute :hidden, Boolean, :default => "false"
+      attribute :responses, Array[KeyboardResponse]
+
+      def validations
+        {
+          type: { required: true, class: [String] },
+          to: { required: true, class: [String] },
+          hidden: {required: false, class: [Boolean] },
+          responses: {required: true, class: [Array] }
+        }
+      end
+    end
+  end
+end
+
+
+

data/lib/rubychy/data_types/keyboard_response.rb

@@ -0,0 +1,17 @@
+module Rubychy
+  module DataTypes
+    class KeyboardResponse < Rubychy::DataTypes::Base
+      attribute :type, String
+      attribute :body, String
+
+      def validations
+        {
+          type: { required: true, class: [String] },
+          body: { required: true, class: [String] },
+        }
+      end
+    end
+  end
+end
+
+

data/lib/rubychy/data_types/keyboards.rb

@@ -0,0 +1,17 @@
+module Rubychy
+  module DataTypes
+    class Keyboards < Rubychy::DataTypes::Base
+      attribute :keyboards, Array[Keyboard]
+
+      def validations
+        {
+          type: { required: true, class: [String] },
+          body: { required: true, class: [String] },
+        }
+      end
+    end
+  end
+end
+
+
+

data/lib/rubychy/data_types/link.rb

@@ -0,0 +1,30 @@
+module Rubychy
+  module DataTypes
+    class Link < Rubychy::DataTypes::SentMessage
+      attribute :url, String
+      attribute :title, String, :default => ""
+      attribute :text, String, :default => ""
+      attribute :noForward, Boolean, :default => false
+
+      def initialize *params
+        super(*params)
+        @type = 'link'
+      end
+
+      def validations
+        {
+          url: { required: true, class: [String] },
+          title: { required: false, drop_empty: true, class: [String] },
+          text: { required: false, drop_empty: true, class: [String] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+          keyboards: { required: false, class: [Array] },
+        }
+      end
+    end
+  end
+end
+
+
+

data/lib/rubychy/data_types/message.rb

@@ -0,0 +1,10 @@
+module Rubychy
+  module DataTypes
+    class Message < Rubychy::DataTypes::Base
+      attribute :type, String
+      attribute :id, String
+      attribute :chatId, String
+      attribute :keyboards, Array[Keyboard]
+    end
+  end
+end

data/lib/rubychy/data_types/picture.rb

@@ -0,0 +1,25 @@
+module Rubychy
+  module DataTypes
+    class Picture < Rubychy::DataTypes::SentMessage
+      attribute :picUrl, String
+      attribute :attribution, String, :default => "gallery"
+
+      def initialize *params
+        super(*params)
+        @type = 'picture'
+      end
+
+      def validations
+        {
+          picUrl: { required: true, class: [String] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+          keyboards: { required: false, class: [Array] },
+        }
+      end
+    end
+  end
+end
+
+

data/lib/rubychy/data_types/read_receipt.rb

@@ -0,0 +1,23 @@
+module Rubychy
+  module DataTypes
+    class ReadReceipt < Rubychy::DataTypes::SentMessage
+      attribute :msgIds, Array[String]
+
+      def initialize *params
+        super(*params)
+        @type = 'read-receipt'
+      end
+
+      def validations
+        {
+          msgIds: { required: true, class: [Array] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+        }
+      end
+    end
+  end
+end
+
+

data/lib/rubychy/data_types/received_message.rb

@@ -0,0 +1,29 @@
+module Rubychy
+  module DataTypes
+    class ReceivedMessage < Rubychy::DataTypes::Message
+      attribute :from, String
+      attribute :timestamp, Integer
+      attribute :readReceiptRequested, Boolean
+      attribute :participants, Array[String]
+      attribute :mention, String
+
+      attribute :body, String
+
+      attribute :attribution, Attribution
+      attribute :noForward, Boolean
+      attribute :readReceiptRequested, Boolean
+
+      attribute :picUrl, String
+
+      attribute :videoUrl, String
+
+      attribute :data, String
+
+      attribute :stickerPackId, String
+      attribute :stickerUrl, String
+
+      attribute :isTyping, Boolean
+    end
+  end
+end
+

data/lib/rubychy/data_types/received_messages.rb

@@ -0,0 +1,7 @@
+module Rubychy
+  module DataTypes
+    class ReceivedMessages < Rubychy::DataTypes::Base
+      attribute :messages, Array[ReceivedMessage]
+    end
+  end
+end

data/lib/rubychy/data_types/sent_message.rb

@@ -0,0 +1,13 @@
+module Rubychy
+  module DataTypes
+    class SentMessage < Rubychy::DataTypes::Message
+      attribute :to, String
+      attribute :delay, Integer
+
+      def validations
+        fail('not implemented')
+      end
+    end
+  end
+end
+

data/lib/rubychy/data_types/text.rb

@@ -0,0 +1,24 @@
+module Rubychy
+  module DataTypes
+    class Text < Rubychy::DataTypes::SentMessage
+      attribute :body, String
+      attribute :typeTime, Integer, :default => 0
+
+      def initialize *params
+        super(*params)
+        @type = 'text'
+      end
+
+      def validations
+        {
+          body: { required: true, class: [String] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+          keyboards: { required: false, class: [Array] },
+        }
+      end
+    end
+  end
+end
+

data/lib/rubychy/data_types/typing.rb

@@ -0,0 +1,23 @@
+module Rubychy
+  module DataTypes
+    class Typing < Rubychy::DataTypes::SentMessage
+      attribute :isTyping, Boolean, :default => false
+
+      def initialize *params
+        super(*params)
+        @type = 'is-typing'
+      end
+
+      def validations
+        {
+          isTyping: { required: true, class: [Boolean] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+        }
+      end
+    end
+  end
+end
+
+

data/lib/rubychy/data_types/user.rb

@@ -0,0 +1,13 @@
+module Rubychy
+  module DataTypes
+    class User < Rubychy::DataTypes::Base
+      attribute :firstName, String
+      attribute :lastName, String
+      attribute :profilePicUrl, String
+      attribute :profilePicLastModified, Integer
+    end
+  end
+end
+
+
+

data/lib/rubychy/data_types/video.rb

@@ -0,0 +1,33 @@
+module Rubychy
+  module DataTypes
+    class Video < Rubychy::DataTypes::SentMessage
+      attribute :videoUrl, String
+      attribute :loop, Boolean, :default => false
+      attribute :muted, Boolean, :default => false
+      attribute :autoplay, Boolean, :default => false
+      attribute :noSave, Boolean, :default => false
+      attribute :typeTime, Integer, :default => 0
+
+      def initialize *params
+        super(*params)
+        @type = 'video'
+      end
+
+      def validations
+        {
+          videoUrl: { required: true, class: [String] },
+          loop: { required: true, class: [TrueClass, FalseClass] },
+          muted: { required: false, drop_empty: true, class: [TrueClass, FalseClass] },
+          autoplay: { required: false, drop_empty: true, class: [TrueClass, FalseClass] },
+          typeTime: { required: false, drop_empty: true, class: [Fixnum] },
+          to: { required: true, class: [String] },
+          type: { required: true, class: [String] },
+          chatId: { required: true, class: [String] },
+          keyboards: { required: false, class: [Array] },
+        }
+      end
+    end
+  end
+end
+
+

data/lib/rubychy/version.rb

@@ -0,0 +1,4 @@
+module Rubychy
+  VERSION = '0.1.0'
+end
+

data/lib/rubychy.rb

@@ -0,0 +1,66 @@
+require 'httpclient'
+require 'virtus'
+require 'multi_json'
+
+require 'rubychy/version'
+require 'rubychy/data_types/base'
+require 'rubychy/data_types/attribution'
+require 'rubychy/data_types/user'
+
+require 'rubychy/data_types/keyboard_response'
+require 'rubychy/data_types/keyboard'
+require 'rubychy/data_types/keyboards'
+
+require 'rubychy/data_types/message'
+require 'rubychy/data_types/sent_message'
+require 'rubychy/data_types/received_message'
+require 'rubychy/data_types/received_messages'
+
+require 'rubychy/data_types/link'
+require 'rubychy/data_types/text'
+require 'rubychy/data_types/picture'
+require 'rubychy/data_types/video'
+require 'rubychy/data_types/typing'
+require 'rubychy/data_types/read_receipt'
+
+require 'rubychy/bot'
+require 'rubychy/api_response'
+
+module Rubychy
+  module Errors
+    # Error returned when a required param is missing
+    class MissingParamsError < StandardError
+      def initialize(parameter, action)
+        super("Missing parameter `#{parameter}` for `#{action}`")
+      end
+    end
+
+    # Error returned when a param type is invalid
+    class InvalidParamTypeError < StandardError
+      def initialize(parameter, current_type, allowed_types)
+        super("Invalid parameter type: `#{parameter}`: `#{current_type}`. Allowed types: #{allowed_types.each { |type| type.class.to_s }.join(',')}.")
+      end
+    end
+
+    # Error returned when something goes bad with your request to the Rubychy API
+    class BadRequestError < StandardError
+      def initialize(error_code, message)
+        super("Bad request. Error code: `#{error_code}` - Message: `#{message}`")
+      end
+    end
+
+    # Error returned when Rubychy API Service is unavailable
+    class ServiceUnavailableError < StandardError
+      def initialize(status_code)
+        super("Rubychy API Service unavailable (HTTP error code #{status_code})")
+      end
+    end
+
+    # Error returned when HTTPClient raise a timeout (?)
+    class TimeoutError < StandardError
+      def initialize(message)
+        super("Timeout reached. Message: #{message}")
+      end
+    end
+  end
+end

data/rubychy.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubychy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubychy"
+  spec.version       = Rubychy::VERSION
+  spec.authors       = ["Nima Kaviani"]
+  spec.email         = ["nima@robochy.com"]
+  spec.description   = %q{Ruby client for the Kik Bot API}
+  spec.summary       = %q{Ruby client for the Kik Bot API}
+  spec.homepage      = "https://github.com/nkaviani/rubychy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "httpclient", "~> 2.6"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "multi_json", "~> 1.11"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rubychy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nima Kaviani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Ruby client for the Kik Bot API
+email:
+- nima@robochy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/rubychy.rb
+- lib/rubychy/api_response.rb
+- lib/rubychy/bot.rb
+- lib/rubychy/data_types/attribution.rb
+- lib/rubychy/data_types/base.rb
+- lib/rubychy/data_types/features.rb
+- lib/rubychy/data_types/keyboard.rb
+- lib/rubychy/data_types/keyboard_response.rb
+- lib/rubychy/data_types/keyboards.rb
+- lib/rubychy/data_types/link.rb
+- lib/rubychy/data_types/message.rb
+- lib/rubychy/data_types/picture.rb
+- lib/rubychy/data_types/read_receipt.rb
+- lib/rubychy/data_types/received_message.rb
+- lib/rubychy/data_types/received_messages.rb
+- lib/rubychy/data_types/sent_message.rb
+- lib/rubychy/data_types/text.rb
+- lib/rubychy/data_types/typing.rb
+- lib/rubychy/data_types/user.rb
+- lib/rubychy/data_types/video.rb
+- lib/rubychy/version.rb
+- rubychy.gemspec
+homepage: https://github.com/nkaviani/rubychy
+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: Ruby client for the Kik Bot API
+test_files: []