line-bot-api 1.29.1 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 641ac83275cf2fc70b8d0b2607db263772cdea79761a1c06f23c4b01d7551f9c
-  data.tar.gz: f315c04b15a28a0a30acf7baa9471298a4c3246177603053c1ddc33aee5d6c52
+  metadata.gz: af4ad962794c7d219f9acb71cbc6e4af3c0b9749087daba28d73d54d2075e0d5
+  data.tar.gz: c219bdefdc560590bddc4f5887e1f219f498867efd0adbcf0e7f051d5dec35ef
 SHA512:
-  metadata.gz: f12cae3acc606ff2400b429074e7c2c8cdd683f7cecae27ff87612cde675780a982c1e76c2ce475a821b79e01ae147f870ffa4d8bbb91217d29ce4879ea868d5
-  data.tar.gz: 0a7d843950f3d7236b31926417f53449616e362926efb0a0fc3ed4434e99c8c8180281acc86d0733a2c07d27d13ce4acf426ddbf796b2b55a011c21ed4af3806
+  metadata.gz: de3b983cab0150be06eb0470679f9a737d039fca49c29c1b7984a0a1648b3576c839835fa2b085cb75b3cbe966ab8c2acf93048519a51b4cac16e82856e9cc2b
+  data.tar.gz: e47210b21072b98f04ba084c90ac80eb66e32b8193ffa64abd85014718c29f2fdaf014de07146ca89a2fd8614be547b28f7a00cb45fc743a16e5e6cc64d1672a

data/CONTRIBUTING.md

@@ -1,15 +1,45 @@
-## How to contribute to LINE Bot SDK for Ruby project
+# How to contribute to LINE Bot SDK for Ruby project
 
-First of all, thank you so much for taking your time to contribute! LINE Bot SDK for Ruby is not very different from any other open
-source projects you are aware of. It will be amazing if you could help us by doing any of the following:
+First of all, thank you so much for taking your time to contribute!
+LINE Bot SDK for Ruby is not very different from any other open source projects you are aware of.
+It will be amazing if you could help us by doing any of the following:
 
-- File an issue in [the issue tracker](https://github.com/line/line-bot-sdk-ruby/issues) to report bugs and propose new features and
-  improvements.
+- File an issue in [the issue tracker](https://github.com/line/line-bot-sdk-ruby/issues) to report bugs and propose new features and improvements.
 - Ask a question using [the issue tracker](https://github.com/line/line-bot-sdk-ruby/issues).
 - Contribute your work by sending [a pull request](https://github.com/line/line-bot-sdk-ruby/pulls).
 
+## Development
+
+### YARD
+
+We use [YARD](https://yardoc.org) to generate and maintain our code documentation.
+**Please make sure your new or modified code is also covered by proper YARD doc comments.**
+Good documentation ensures that contributors and users can easily read and understand how the methods and classes work.
+
+#### How to generate and view documentation locally
+
+##### 1. **Start a local documentation server**
+
+Run the following command to start a local YARD server that will automatically reload when files change:
+
+```bash
+bundle exec yard server --reload
+```
+
+Then open the printed URL in your browser (e.g., http://localhost:8808).
+
+##### 2. **Validate your documentation**  
+
+Before pushing your changes, run the following command to check YARD documentation coverage and warnings:
+```bash
+bundle exec yard stats ./lib/line/bot/v2 --fail-on-warning
+```
+This will fail if there are missing doc comments or any YARD-specific warnings.
+Make sure to fix any issues before creating a pull request.
+
+For more details on how to write YARD doc comments, refer to YARD’s official [Getting Started guide](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md).
+
 ### Contributor license agreement
 
-When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign
-[the ICLA (individual contributor license agreement)](https://cla-assistant.io/line/line-bot-sdk-ruby). Please
-[contact us](mailto:dl_oss_dev@linecorp.com) if you need the CCLA (corporate contributor license agreement).
+When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign [the ICLA (individual contributor license agreement)](https://cla-assistant.io/line/line-bot-sdk-ruby).
+Please [contact us](mailto:dl_oss_dev@linecorp.com) if you need the CCLA (corporate contributor license agreement).

data/README.md

@@ -18,7 +18,7 @@ Also, generated documentation by YARD is available.
 - https://rubydoc.info/gems/line-bot-api
 
 ## Requirements
-This library requires Ruby 3.1 or later.
+This library requires Ruby 3.2 or later.
 
 ## Installation
 

data/lib/line/bot/{api → v1/api}/errors.rb

@@ -15,6 +15,8 @@
 module Line
   module Bot
     module API
+      # @deprecated
+      # This is obsolete. (and there is no caller...)
       class Error < StandardError; end
     end
   end

data/lib/line/bot/{api → v1/api}/version.rb

@@ -15,7 +15,9 @@
 module Line
   module Bot
     module API
-      VERSION = "1.29.1"
+      # @deprecated
+      # Use {Line::Bot::VERSION} instead.
+      VERSION = "1.30.0-deprecated"
     end
   end
 end

data/lib/line/bot/{api.rb → v1/api.rb}

@@ -12,10 +12,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-require 'line/bot/api/version'
+require 'line/bot/v1/api/version'
 
 module Line
   module Bot
+    # @deprecated
+    # This is obsolete.
     module API
       DEFAULT_OAUTH_ENDPOINT = "https://api.line.me"
       DEFAULT_ENDPOINT = "https://api.line.me/v2"