line-bot-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53328dc34338632959e4d41e639b22fb47c0c2b5
-  data.tar.gz: ce8777fa1029e0ab4094e86591684795911f0089
+  metadata.gz: 8b35492a0cc51c944088a4f3837e609d23d0e11d
+  data.tar.gz: 1160d8e67dc7dd7f8001a8dcc17df23f0ad33c18
 SHA512:
-  metadata.gz: c9edcef377b3c0cbc1a70260eec62addfb93b4bf4353ca19b45ffc0545008b328369d8428fb0d36b776914c6ca933eff6cc4296b56c861d6f520b92aa02554a5
-  data.tar.gz: b577b38f12b817325958a474578010c404c9069d93409d0d32e6593210e50f5b76c2df33656c32a62498483449aa30d977e535c589ccd009ae917771632c83e0
+  metadata.gz: 832ca392ab39f819f7b15cb3b6824e74fb90a4a3175fc1fa5435b39f3c3137c1e0e4a96606b233442a01b0c2eaa111070e4328693e441836dcaa484d0540e8ac
+  data.tar.gz: 43e8eb81314369f4275bf17f04f134ab91a3d096512e1269a7a3149943f5596b9fb3ed04a4caae2ba221a5c876167b0562283bd10c6267f8e9ad81c8888a7ca1

data/README.md

@@ -2,7 +2,7 @@
 
 Line::Bot::API - SDK of the LINE BOT API Trial for Ruby
 
-[![Gem-version](https://img.shields.io/gem/v/line-bot-api.svg)](https://rubygems.org/gems/) [![Build Status](https://travis-ci.org/line/line-bot-sdk-ruby.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-ruby)
+[![Gem-version](https://img.shields.io/gem/v/line-bot-api.svg)](https://rubygems.org/gems/line-bot-api) [![Build Status](https://travis-ci.org/line/line-bot-sdk-ruby.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-ruby)
 
 ## Installation
 
@@ -188,7 +188,7 @@ end
 request_from_rack = Rack::Request.new( .. )
 
 request = Line::Bot::Receive::Request.new(request_from_rack.env)
-request.data #=> [Array] Line::Bot::Receive::Message || Line::Bot::Receive::Operation
+request.data #=> [Array<Line::Bot::Receive::Message || Line::Bot::Receive::Operation>]
 
 request.data.each { |message|
   case message.content
@@ -219,7 +219,7 @@ Get the preview image file which was sent by user.
 ```
 user_profile = client.get_user_profile("1234567")
 user_profile #=> [Line::Bot::Response::User::Profile]
-user_profile.contacts #=> [Array] Line::Bot::Response::User::Contact
+user_profile.contacts #=> [Array<Line::Bot::Response::User::Contact>]
 ```
 
 ## License

data/lib/line/bot/api/version.rb

@@ -1,7 +1,7 @@
 module Line
   module Bot
     module API
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -9,13 +9,19 @@ require 'net/http'
 module Line
   module Bot
     class Client
+
+      #  @return [String]
       attr_accessor :channel_id, :channel_secret, :channel_mid
 
-      # Initializes a new Bot Client
+      # Initialize a new Bot Client.
       #
       # @param options [Hash]
+      #
       # @return [LINE::Bot::Client]
-      def initialize
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
         yield(self) if block_given?
       end
 
@@ -32,11 +38,12 @@ module Line
         credentials.values.all?
       end
 
-      # Sends text to users
+      # Send text to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:text] [String]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param text [String]
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :text keys.
       #
       # @return [Net::HTTPResponse]
@@ -47,12 +54,13 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends image to users
+      # Send image to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:image_url] [String] Image file's url
-      # @param attrs [:preview_url] [String] Preview image file's url
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param image_url [String] Image file's url
+      #   @param preview_url [String] Preview image file's url
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :image_url, :preview_url keys.
       #
       # @return [Net::HTTPResponse]
@@ -64,12 +72,13 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends video to users
+      # Send video to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:video_url] [String] Video file's url
-      # @param attrs [:preview_url] [String] Preview image file's url
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param video_url [String] Video file's url
+      #   @param preview_url [String] Preview image file's url
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :video_url, :preview_url keys.
       #
       # @return [Net::HTTPResponse]
@@ -81,12 +90,13 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends audio to users
+      # Send audio to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:audio_url] [String] Audio file's url
-      # @param attrs [:duration] [String or Integer] Voice message's length, milliseconds
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param audio_url [String] Audio file's url
+      #   @param duration [String or Integer] Voice message's length, milliseconds
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :audio_url, :duration keys.
       #
       # @return [Net::HTTPResponse]
@@ -98,14 +108,15 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends location to users
+      # Send location to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:title] [String] Location's title
-      # @param attrs [:address] [String] Location's address
-      # @param attrs [:latitude] [Float] Location's latitude
-      # @param attrs [:longitude] [Float] Location's longitude
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param title [String] Location's title
+      #   @param address [String] Location's address
+      #   @param latitude [Float] Location's latitude
+      #   @param longitude [Float] Location's longitude
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :title, :latitude, :longitude keys.
       #
       # @return [Net::HTTPResponse]
@@ -119,13 +130,14 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends sticker to users
+      # Send sticker to users.
       #
       # @param attrs [Hash]
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
-      # @param attrs [:stkpkgid] [String or Integer] Sticker's package identifier
-      # @param attrs [:stkid] [String or Integer] Sticker's identifier
-      # @param attrs [:stkver] [String or Integer] Sticker's version number
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param stkpkgid [String or Integer] Sticker's package identifier
+      #   @param stkid [String or Integer] Sticker's identifier
+      #   @param stkver [String or Integer] Sticker's version number
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :stkpkgid, :stkid, :stkver keys.
       #
       # @return [Net::HTTPResponse]
@@ -138,10 +150,11 @@ module Line
         send_message(attrs[:to_mid], message)
       end
 
-      # Sends message to line server and to users
+      # Send message to line server and to users.
       #
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
+      # @param to_mid [String or Array] User's identifiers
       # @param message [Line::Bot::Message]
+      #
       # @raise [ArgumentError] Error raised when supplied argument are missing message.
       #
       # @return [Net::HTTPResponse]
@@ -158,7 +171,7 @@ module Line
         request.post
       end
 
-      # Gets message content
+      # Get message content.
       #
       # @param identifer [String] Message's identifier
       #
@@ -170,7 +183,7 @@ module Line
         get(endpoint_path)
       end
 
-      # Gets preview of message content
+      # Get preview of message content.
       #
       # @param identifer [String] Message's identifier
       #
@@ -182,15 +195,17 @@ module Line
         get(endpoint_path)
       end
 
-      # Gets user profile
+      # Get user profile.
       #
-      # @param attrs [:to_mid] [String or Array] User's indentifiers
+      # @param mids [String or Array] User's identifiers
       #
       # @raise [ArgumentError] Error raised when supplied argument are missing message.
       # @raise [HTTPError]
       #
       # @return [Line::Bot::Response::User::Profile]
       def get_user_profile(mids)
+        raise ArgumentError, 'Invalid arguments, mids' unless mids.instance_of?(String) || mids.instance_of?(Array)
+
         mids = mids.instance_of?(String) ? [mids] : mids
         endpoint_path  = "/v1/profiles?mids=#{mids.join(',')}"
 
@@ -199,7 +214,7 @@ module Line
         Line::Bot::Response::User::Profile.new(response) if !response.value
       end
 
-      # Fetches data
+      # Fetch data, get content of specified URL.
       #
       # @param endpoint_path [String]
       #
@@ -215,21 +230,21 @@ module Line
         request.get
       end
 
-      # Creates rich message to line server and to users
+      # Create rich message to line server and to users.
       #
       # @return [Line::Bot::Builder::RichMessage]
       def rich_message
         Line::Bot::Builder::RichMessage.new(self)
       end
 
-      # Creates multiple message to line server and to users
+      # Create multiple message to line server and to users.
       #
       # @return [Line::Bot::Builder::MultipleMessage]
       def multiple_message
         Line::Bot::Builder::MultipleMessage.new(self)
       end
 
-      # Validates signature
+      # Validate signature
       #
       # @param content [String] Request's body
       # @param channel_signature [String] Request'header 'X-LINE-ChannelSignature' # HTTP_X_LINE_CHANNELSIGNATURE
@@ -244,15 +259,17 @@ module Line
         variable_secure_compare(channel_signature, signature)
       end
 
-      private
+    private
       # Constant time string comparison.
       #
       # via timing attacks.
       # reference: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/security_utils.rb
+      # @return [Boolean]
       def variable_secure_compare(a, b)
         secure_compare(::Digest::SHA256.hexdigest(a), ::Digest::SHA256.hexdigest(b))
       end
 
+      # @return [Boolean]
       def secure_compare(a, b)
         return false unless a.bytesize == b.bytesize
 

data/lib/line/bot/receive/operation.rb

@@ -7,9 +7,9 @@ module Line
         attr_reader :id, :from_mid, :to_mid, :from_channel_id, :to_channel_id, :event_type, :content
 
         def initialize(env)
-          @id = env['content']['id']
-          @from_mid = env['content']['from']
-          @to_mid = env['content']['to']
+          @id = env['id']
+          @from_mid = env['content']['params'].first
+          @to_mid = env['to']
 
           @from_channel_id = env['fromChannel']
           @to_channel_id = env['toChannel']

data/lib/line/bot/request.rb

@@ -7,10 +7,14 @@ module Line
     class Request
       attr_accessor :endpoint_path, :credentials, :to_mid, :message
 
+      # Initializes a new Request
+      #
+      # @return [LINE::Bot::Client]
       def initialize
         yield(self) if block_given?
       end
 
+      # @return [Net::HTTP]
       def https
         https = Net::HTTP.new('trialbot-api.line.me', 443)
         https.use_ssl = true
@@ -18,14 +22,19 @@ module Line
         https
       end
 
+      # @return [Array]
       def to
+        raise ArgumentError, 'Invalid arguments, to_mid' unless to_mid.instance_of?(String) || to_mid.instance_of?(Array)
+
         to_mid.instance_of?(String) ? [to_mid] : to_mid
       end
 
+      # @return [Line::Bot::Message::Base#content]
       def content
         message.content
       end
 
+      # @return [Hash]
       def payload
         payload = {
           to: to,
@@ -37,6 +46,7 @@ module Line
         payload.to_json
       end
 
+      # @return [Hash]
       def header
         header = {
           'Content-Type' => 'application/json; charset=UTF-8',
@@ -47,12 +57,22 @@ module Line
         header.merge(hash)
       end
 
+      # Get content of specified URL.
+      #
+      # @raise [ArgumentError]
+      #
+      # @return [Net::HTTPResponse]
       def get
         raise ArgumentError, "Invalid arguments" unless validate_for_getting_message?
 
         https.get(endpoint_path, header)
       end
 
+      # Post content of specified URL.
+      #
+      # @raise [ArgumentError]
+      #
+      # @return [Net::HTTPResponse]
       def post
         raise ArgumentError, "Invalid arguments" unless validate_for_posting_message?
 

data/line-bot-api.gemspec

@@ -6,10 +6,10 @@ require 'line/bot/api/version'
 Gem::Specification.new do |spec|
   spec.name          = "line-bot-api"
   spec.version       = Line::Bot::API::VERSION
-  spec.authors       = ["LINE Corporation", "Hirohisa Kawasaki"]
+  spec.authors       = ["LINE Corporation"]
   spec.email         = ["hirohisa.kawasaki@gmail.com"]
 
-  spec.description   = "LINE::Bot::API - SDK of the LINE BOT API"
+  spec.description   = "Line::Bot::API - SDK of the LINE BOT API"
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/line/line-bot-sdk-ruby"
   spec.license       = "Apache License, Version 2.0"
@@ -20,10 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version     = '>= 2.0.0'
 
-  spec.add_dependency 'rack', '~> 1.6.4'
+  spec.add_dependency 'rack', '~> 1.6'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "addressable", ">= 2.3.6"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - LINE Corporation
-- Hirohisa Kawasaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +94,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-description: LINE::Bot::API - SDK of the LINE BOT API
+description: Line::Bot::API - SDK of the LINE BOT API
 email:
 - hirohisa.kawasaki@gmail.com
 executables: []
@@ -142,5 +155,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: LINE::Bot::API - SDK of the LINE BOT API
+summary: Line::Bot::API - SDK of the LINE BOT API
 test_files: []