line-bot-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cd22ba8ed93ba3f1577f70a5095439755dda529
+  data.tar.gz: 75eae8e81a15b2e6d950487dd18516aea4fd95f9
+SHA512:
+  metadata.gz: dce0e680763a9d4929580cdb9e0fb75ee7591071d95d2687496e696dbc5ffe666e51644e615c94a31934ffe53e7c66e1e73739fe826dae62471678e114163842
+  data.tar.gz: 7a9538fb64eed37b366366658af3707dce8664e3b26967db41809c2bd0379ec476a60f2359e97f8eb029f6c0c963cd802621492b38e67fd0be6086b59912168b

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hirohisa.kawasaki@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,216 @@
+# LINE::Bot::API
+
+LINE::Bot::API - SDK of the LINE BOT API Trial for Ruby
+
+## Configuration
+
+```
+client = Line::Bot::Client.new do |config|
+  config.channel_id = 'YOUR LINE BOT Channel ID'
+  config.channel_secret = 'YOUR LINE BOT Channel Secret'
+  config.channel_mid = 'YOUR LINE BOT MID'
+end
+```
+
+## Usage
+
+### Sending messages
+
+After configuring a client, you can start sending messages as the following reference.
+
+- [https://developers.line.me/bot-api/api-reference#sending_message](https://developers.line.me/bot-api/api-reference#sending_message)
+
+Sending message APIs requires the following parameter.
+- `:to_mid` String or Array
+
+```
+client.send_text(
+  to_mid: '12345678',
+)
+client.send_text(
+  to_mid: ['12345678', '23456789'],
+)
+```
+
+#### send_text
+
+```
+client.send_text(
+  to_mid: to_mid,
+  text: 'Hello',
+)
+```
+
+#### send_image
+
+```
+client.send_image(
+  to_mid: to_mid,
+  image_url: 'http://example.com/image.jpg',            # originalContentUrl
+  preview_url: 'http://example.com/image_preview.jpg',  # previewImageUrl
+)
+```
+
+#### send_video
+
+```
+client.send_video(
+  to_mid: to_mid,
+  video_url: 'http://example.com/video.mp4',            # originalContentUrl
+  preview_url: 'http://example.com/video_preview.jpg'   # previewImageUrl
+)
+```
+
+#### send_audio
+
+```
+client.send_audio(
+  to_mid: to_mid,
+  audio_url: 'http://example.com/audio.mp3',            # originalContentUrl
+  duration: 120000
+)
+```
+
+#### send_location
+
+```
+client.send_location(
+  to_mid: to_mid,
+  title: 'LINE Corporation.',
+  address: 'Hikarie  Shibuya-ku Tokyo 151-0002',        # location.address
+  latitude: 35.61823286112982,                          # location.latitude
+  longitude: 139.72824096679688,                        # location.longitude
+)
+```
+
+#### send_sticker
+
+See online documentation to find which sticker's you can send.
+
+- [https://developers.line.me/bot-api/api-reference#sending_message_sticker](https://developers.line.me/bot-api/api-reference#sending_message_sticker)
+
+```
+client.send_sticker(
+  to_mid: to_mid,
+  stkpkgid: 2,                                          # contentMetadata.STKPKGID
+  stkid: 144,                                           # contentMetadata.STKID
+  stkver: 100                                           # contentMetadata.STKVER
+)
+```
+
+### Sending multiple message
+
+Support on sending multiple message.
+- [https://developers.line.me/bot-api/api-reference#sending_multiple_messages](https://developers.line.me/bot-api/api-reference#sending_multiple_messages)
+
+```
+client.multiple_message.add_text(
+  text: text,
+).add_image(
+  image_url: image_url,
+  preview_url: preview_url,
+).add_video(
+  video_url: video_url,
+  preview_url: preview_url,
+).add_audio(
+  audio_url: audio_url,
+  duration: duration,
+).add_location(
+  title: 'title',
+  latitude: latitude,
+  longitude: longitude,
+).add_sticker(
+  stkpkgid: stkpkgid,
+  stkid: stkid,
+  stkver: stkver,
+).send(
+  to_mid: to_mid,
+)
+```
+
+### Sending rich message
+
+Support on sending rich message.
+
+See also a online document.
+- [https://developers.line.me/bot-api/api-reference#sending_rich_content_message](https://developers.line.me/bot-api/api-reference#sending_rich_content_message)
+
+```
+client.rich_message.set_action(
+  MANGA: {
+    text: 'manga',
+    link_url: link_url,
+  }
+).add_listener(
+  action: 'MANGA',
+  x: 0,
+  y: 0,
+  width: 520,
+  height: 520,
+).send(
+  to_mid: to_mid,
+  image_url: image_url,
+  alt_text: alt_text,
+)
+```
+
+### Signature validation
+
+```
+request = Rack::Request.new( .. )
+signature = request.env['HTTP_X_LINE_CHANNELSIGNATURE']
+unless client.validate_signature(request.body.read, signature)
+  return 'invalidation of signature'
+end
+```
+
+### Receiving request
+
+```
+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.each { |message|
+  case message.content
+  when Line::Bot::Message::Image, Line::Bot::Message::Video
+    # get message content
+    response = client.get_message_content(message.id)
+    tf = Tempfile.open("content")
+    tf.write(response.body)
+
+    # get preview of message content
+    preview_response = client.get_message_content_preview(message.id)
+    ptf = Tempfile.open("content_preview")
+    ptf.write(preview_response.body)
+  end
+}
+```
+
+### Getting message content
+
+Get the original file which was sent by user.
+
+### Getting preview of message content
+
+Get the preview image file which was sent by user.
+
+### Getting user profile information
+
+```
+user_profile = client.get_user_profile("1234567")
+user_profile #=> [Line::Bot::Response::User::Profile]
+contacts = user_profile.contacts
+contacts #=> [Array] Line::Bot::Response::User::Contacts
+```
+
+## License
+
+The gem is available as open source under the terms of the [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
+
+## Links
+
+- [https://business.line.me/](https://business.line.me/)
+- [https://developers.line.me/bot-api/overview](https://developers.line.me/bot-api/overview)
+- [https://developers.line.me/bot-api/getting-started-with-bot-api-trial](https://developers.line.me/bot-api/getting-started-with-bot-api-trial)