chatwork 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52031d9d56999ff66bad2a4617fb83027540f1f32dd17a5bfa9d6920a94aaf9e
-  data.tar.gz: 90555909fa6e8990000d9c4eef8fd94e599a01b0a647a20ca09135b0bb65d435
+  metadata.gz: 4f74e386e6cd2bfdb296f318244c848833efe5281661a70fd5f2b25997e5bbcc
+  data.tar.gz: ec96eec7324daf0413443dbae362119ed08191b89627269fdc5a757313a829c5
 SHA512:
-  metadata.gz: 4bfdc23a78474cd708e33b97d906ed6ada4aefa15d1028e85826a501efbe02aa5e5567fd69d8fd25faf1ee4a28661a994a13474a50e51d007eee1ab8c2b7ba0c
-  data.tar.gz: 5eb280a4f59d87e467f33510f0d6ee799eed7d1e10e49b72c3dd5d7e48eb7748578e605510fc390143409cb50aee8970ccf8108f67c48dfabb1bb38cf810258d
+  metadata.gz: cade7059d99ac62bb9245a8f0089007605fb0f29f887c4bfa7947165180649388cfc1466dd760491023feb523584fedc0a4288d5d4f4b252d5e5e63c81374ebd
+  data.tar.gz: 0e7b226006c9a84f650139ca991b2eebfda2576f6cad148da5b8fde20deceba3d00fd07de10d18588b2913c09384661e05d65e4b5149b2bfb886ac956a9aa651

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 ## Unreleased
-[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.2...master)
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.7.0...master)
+
+## v0.7.0
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.2...v0.7.0)
+
+* Support Invitation Link API
+  * https://github.com/asonas/chatwork-ruby/pull/46
 
 ## v0.6.2
 [Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.1...v0.6.2)

data/lib/chatwork.rb

@@ -12,6 +12,7 @@ module ChatWork
   autoload :EntityMethods,      "chatwork/entity_methods"
   autoload :File,               "chatwork/file"
   autoload :IncomingRequest,    "chatwork/incoming_request"
+  autoload :InvitationLink,     "chatwork/invitation_link"
   autoload :Me,                 "chatwork/me"
   autoload :Member,             "chatwork/member"
   autoload :Message,            "chatwork/message"

data/lib/chatwork/invitation_link.rb

@@ -0,0 +1,98 @@
+module ChatWork
+  module InvitationLink
+    extend EntityMethods
+
+    # Get invitation link
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-link
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "public": true,
+    #     "url": "https://example.chatwork.com/g/randomcode42",
+    #     "need_acceptance": true,
+    #     "description": "Link description text"
+    #   }
+    def self.get(room_id:)
+      _get("/rooms/#{room_id}/link")
+    end
+
+    # Create invitation link
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-link
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    # @param code [String] link path (default. random string)
+    # @param description [String] description of link page
+    # @param need_acceptance [Boolean] Approval necessity. Whether participation requires administrator approval.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "public": true,
+    #     "url": "https://example.chatwork.com/g/unique-link-name",
+    #     "need_acceptance": true,
+    #     "description": "This is a public room for topic A."
+    #   }
+    def self.create(room_id:, code: nil, description: nil, need_acceptance: nil)
+      params = {
+        code:            code,
+        description:     description,
+        need_acceptance: boolean_to_integer(need_acceptance),
+      }
+      _post("/rooms/#{room_id}/link", params)
+    end
+
+    # Update invitation link
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-link
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    # @param code [String] link path (default. random string)
+    # @param description [String] description of link page
+    # @param need_acceptance [Boolean] Approval necessity. Whether participation requires administrator approval.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "public": true,
+    #     "url": "https://example.chatwork.com/g/another_link_name",
+    #     "need_acceptance": false,
+    #     "description": "Public room for everybody"
+    #   }
+    def self.update(room_id:, code: nil, description: nil, need_acceptance: nil)
+      params = {
+        code:            code,
+        description:     description,
+        need_acceptance: boolean_to_integer(need_acceptance),
+      }
+      _put("/rooms/#{room_id}/link", params)
+    end
+
+    # Delete invitation link
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id-link
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "public": false
+    #   }
+    def self.destroy(room_id:)
+      _delete("/rooms/#{room_id}/link")
+    end
+  end
+end

data/lib/chatwork/room.rb

@@ -46,6 +46,9 @@ module ChatWork
     # @param members_member_ids [Array<Integer>, String] List of user IDs who will be given member permission for the group chat.
     # @param members_readonly_ids [Array<Integer>, String] List of user IDs who will be given read-only permission for the group chat.
     # @param name [String] Title of the group chat.
+    # @param link [Boolean] whether create invitation link
+    # @param link_code [String] link path (default. random string)
+    # @param link_need_acceptance [Boolean] Approval necessity. Whether participation requires administrator approval.
     #
     # @return [Hashie::Mash]
     #
@@ -53,12 +56,16 @@ module ChatWork
     #   {
     #     "room_id": 1234
     #   }
-    def self.create(description: nil, icon_preset: nil, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, name:)
+    def self.create(description: nil, icon_preset: nil, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, name:,
+                    link: nil, link_code: nil, link_need_acceptance: nil)
       params = {
-        description:       description,
-        icon_preset:       icon_preset,
-        members_admin_ids: Array(members_admin_ids).join(","),
-        name:              name,
+        description:          description,
+        icon_preset:          icon_preset,
+        members_admin_ids:    Array(members_admin_ids).join(","),
+        name:                 name,
+        link:                 boolean_to_integer(link),
+        link_need_acceptance: boolean_to_integer(link_need_acceptance),
+        link_code:            link_code,
       }
       params[:members_member_ids] = Array(members_member_ids).join(",") if members_member_ids
       params[:members_readonly_ids] = Array(members_readonly_ids).join(",") if members_readonly_ids

data/lib/chatwork/version.rb

@@ -1,3 +1,3 @@
 module ChatWork
-  VERSION = "0.6.2".freeze
+  VERSION = "0.7.0".freeze
 end

data/spec/lib/chatwork/invitation_link_spec.rb

@@ -0,0 +1,69 @@
+describe ChatWork::InvitationLink do
+  describe ".get", type: :api do
+    subject { ChatWork::InvitationLink.get(room_id: room_id) }
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:get, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/link"
+  end
+
+  describe ".create", type: :api do
+    subject do
+      ChatWork::InvitationLink.create(
+        room_id:         room_id,
+        code:            code,
+        description:     description,
+        need_acceptance: need_acceptance,
+      )
+    end
+
+    let(:room_id)         { 123 }
+    let(:code)            { "unique-link-name" }
+    let(:description)     { "This is a public room for topic A." }
+    let(:need_acceptance) { true }
+
+    before do
+      stub_chatwork_request(:post, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :post, "/rooms/{room_id}/link"
+  end
+
+  describe ".update", type: :api do
+    subject do
+      ChatWork::InvitationLink.update(
+        room_id:         room_id,
+        code:            code,
+        description:     description,
+        need_acceptance: need_acceptance,
+      )
+    end
+
+    let(:room_id)         { 123 }
+    let(:code)            { "another_link_name" }
+    let(:description)     { "Public room for everybody" }
+    let(:need_acceptance) { false }
+
+    before do
+      stub_chatwork_request(:put, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :put, "/rooms/{room_id}/link"
+  end
+
+  describe ".destroy", type: :api do
+    subject { ChatWork::InvitationLink.destroy(room_id: room_id) }
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:delete, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :delete, "/rooms/{room_id}/link"
+  end
+end

data/spec/lib/chatwork/room_spec.rb

@@ -20,12 +20,18 @@ describe ChatWork::Room do
         members_member_ids:   members_member_ids,
         members_readonly_ids: members_readonly_ids,
         name:                 name,
+        link:                 link,
+        link_code:            link_code,
+        link_need_acceptance: link_need_acceptance,
       )
     end
 
-    let(:description) { "group chat description" }
-    let(:icon_preset) { "meeting" }
-    let(:name)        { "Website renewal project" }
+    let(:description)          { "group chat description" }
+    let(:icon_preset)          { "meeting" }
+    let(:name)                 { "Website renewal project" }
+    let(:link)                 { false }
+    let(:link_need_acceptance) { true }
+    let(:link_code)            { nil }
 
     before do
       stub_chatwork_request(:post, "/rooms")

data/spec/support/utils/raml_parser.rb

@@ -33,7 +33,7 @@ module RamlParser
     nil
   end
 
-  def self.find_query_parameter_example(verb, path)
+  def self.find_query_parameter_example(verb, path) # rubocop:disable Metrics/MethodLength
     resource = find_resource(verb, path)
     return {} unless resource
 
@@ -41,7 +41,8 @@ module RamlParser
 
     if resource["queryParameters"]
       resource["queryParameters"].each do |name, value|
-        parameter_example[name] = value["example"]
+        example = find_example(value)
+        parameter_example[name] = example if example
       end
     end
 
@@ -52,7 +53,8 @@ module RamlParser
         next unless trait["queryParameters"]
 
         trait["queryParameters"].each do |name, value|
-          parameter_example[name] = value["example"]
+          example = find_example(value)
+          parameter_example[name] = example if example
         end
       end
     end
@@ -77,4 +79,25 @@ module RamlParser
     response_json
   end
   private_class_method :parse_response
+
+  def self.find_example(value)
+    example =
+      if value.has_key?("example")
+        value["example"]
+      elsif value.has_key?("default")
+        value["default"]
+      end
+
+    return nil if example.nil?
+
+    case example
+    when true
+      1
+    when false
+      0
+    else
+      example
+    end
+  end
+  private_class_method :find_example
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatwork
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - asonas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -279,6 +279,7 @@ files:
 - lib/chatwork/entity_methods.rb
 - lib/chatwork/file.rb
 - lib/chatwork/incoming_request.rb
+- lib/chatwork/invitation_link.rb
 - lib/chatwork/me.rb
 - lib/chatwork/member.rb
 - lib/chatwork/message.rb
@@ -295,6 +296,7 @@ files:
 - spec/lib/chatwork/entity_methods_spec.rb
 - spec/lib/chatwork/file_spec.rb
 - spec/lib/chatwork/incoming_request_spec.rb
+- spec/lib/chatwork/invitation_link_spec.rb
 - spec/lib/chatwork/me_spec.rb
 - spec/lib/chatwork/member_spec.rb
 - spec/lib/chatwork/message_spec.rb
@@ -342,6 +344,7 @@ test_files:
 - spec/lib/chatwork/entity_methods_spec.rb
 - spec/lib/chatwork/file_spec.rb
 - spec/lib/chatwork/incoming_request_spec.rb
+- spec/lib/chatwork/invitation_link_spec.rb
 - spec/lib/chatwork/me_spec.rb
 - spec/lib/chatwork/member_spec.rb
 - spec/lib/chatwork/message_spec.rb