knockapi 0.4.9 → 0.4.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/.tool-versions +1 -0
 - data/Gemfile.lock +1 -1
 - data/README.md +7 -7
 - data/lib/knock/client.rb +2 -3
 - data/lib/knock/objects.rb +17 -0
 - data/lib/knock/version.rb +1 -1
 - metadata +6 -5
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 0ddc00df3cb669fa52a54e7e26232a07667b7206b7ebe79b9df585ca23c4ddae
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: 9a96083148d5c5c822782643a8d3e8b86f7baf7ea9e2e38802b6a4c7ad1dcccb
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: 9759c24b6bb7b3625832e4eb820ab63522dac55c65a42c7e81dc196dd5ccaad2db1ab90013e25d109bc94692c52ee83b3826955bd2a26f21dcb1677f0cff64eb
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: 3c790e4b2cefbb69c5cb7c2b856ad651b0ffe525b4f48cc0b4807537998c643abef5bf74e73491b71df421f21184efd3e20777032a0465d1fefe3bf75ba88e02
         
     | 
    
        data/.tool-versions
    ADDED
    
    | 
         @@ -0,0 +1 @@ 
     | 
|
| 
      
 1 
     | 
    
         
            +
            ruby 3.2.2
         
     | 
    
        data/Gemfile.lock
    CHANGED
    
    
    
        data/README.md
    CHANGED
    
    | 
         @@ -34,7 +34,7 @@ Knock.key = 'sk_12345' 
     | 
|
| 
       34 
34 
     | 
    
         
             
            ### Identifying users
         
     | 
| 
       35 
35 
     | 
    
         | 
| 
       36 
36 
     | 
    
         
             
            ```ruby
         
     | 
| 
       37 
     | 
    
         
            -
            require " 
     | 
| 
      
 37 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       38 
38 
     | 
    
         | 
| 
       39 
39 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       40 
40 
     | 
    
         | 
| 
         @@ -50,7 +50,7 @@ Knock::Users.identify( 
     | 
|
| 
       50 
50 
     | 
    
         
             
            ### Sending notifies (triggering workflows)
         
     | 
| 
       51 
51 
     | 
    
         | 
| 
       52 
52 
     | 
    
         
             
            ```ruby
         
     | 
| 
       53 
     | 
    
         
            -
            require " 
     | 
| 
      
 53 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       54 
54 
     | 
    
         | 
| 
       55 
55 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       56 
56 
     | 
    
         | 
| 
         @@ -74,7 +74,7 @@ Knock::Workflows.trigger( 
     | 
|
| 
       74 
74 
     | 
    
         
             
            ### Retrieving users
         
     | 
| 
       75 
75 
     | 
    
         | 
| 
       76 
76 
     | 
    
         
             
            ```ruby
         
     | 
| 
       77 
     | 
    
         
            -
            require " 
     | 
| 
      
 77 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       78 
78 
     | 
    
         | 
| 
       79 
79 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       80 
80 
     | 
    
         | 
| 
         @@ -84,7 +84,7 @@ Knock::Users.get(id: "jhammond") 
     | 
|
| 
       84 
84 
     | 
    
         
             
            ### Deleting users
         
     | 
| 
       85 
85 
     | 
    
         | 
| 
       86 
86 
     | 
    
         
             
            ```ruby
         
     | 
| 
       87 
     | 
    
         
            -
            require " 
     | 
| 
      
 87 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       88 
88 
     | 
    
         | 
| 
       89 
89 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       90 
90 
     | 
    
         | 
| 
         @@ -94,7 +94,7 @@ Knock::Users.delete(id: "jhammond") 
     | 
|
| 
       94 
94 
     | 
    
         
             
            ### Preferences
         
     | 
| 
       95 
95 
     | 
    
         | 
| 
       96 
96 
     | 
    
         
             
            ```ruby
         
     | 
| 
       97 
     | 
    
         
            -
            require " 
     | 
| 
      
 97 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       98 
98 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       99 
99 
     | 
    
         | 
| 
       100 
100 
     | 
    
         
             
            # Set an entire preference set
         
     | 
| 
         @@ -115,7 +115,7 @@ Knock::Users.get_preferences(user_id: "jhammond") 
     | 
|
| 
       115 
115 
     | 
    
         
             
            ### Getting and setting channel data
         
     | 
| 
       116 
116 
     | 
    
         | 
| 
       117 
117 
     | 
    
         
             
            ```ruby
         
     | 
| 
       118 
     | 
    
         
            -
            require " 
     | 
| 
      
 118 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       119 
119 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       120 
120 
     | 
    
         | 
| 
       121 
121 
     | 
    
         
             
            # Set channel data for an APNS
         
     | 
| 
         @@ -134,7 +134,7 @@ Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNE 
     | 
|
| 
       134 
134 
     | 
    
         
             
            ### Cancelling workflows
         
     | 
| 
       135 
135 
     | 
    
         | 
| 
       136 
136 
     | 
    
         
             
            ```ruby
         
     | 
| 
       137 
     | 
    
         
            -
            require " 
     | 
| 
      
 137 
     | 
    
         
            +
            require "knock"
         
     | 
| 
       138 
138 
     | 
    
         
             
            Knock.key = "sk_12345"
         
     | 
| 
       139 
139 
     | 
    
         | 
| 
       140 
140 
     | 
    
         
             
            Knock::Workflows.cancel(
         
     | 
    
        data/lib/knock/client.rb
    CHANGED
    
    | 
         @@ -8,9 +8,8 @@ module Knock 
     | 
|
| 
       8 
8 
     | 
    
         
             
                def client
         
     | 
| 
       9 
9 
     | 
    
         
             
                  return @client if defined?(@client)
         
     | 
| 
       10 
10 
     | 
    
         | 
| 
       11 
     | 
    
         
            -
                  @client = Net::HTTP.new(Knock::API_HOSTNAME,  
     | 
| 
       12 
     | 
    
         
            -
                   
     | 
| 
       13 
     | 
    
         
            -
                  # @client.use_ssl = true
         
     | 
| 
      
 11 
     | 
    
         
            +
                  @client = Net::HTTP.new(Knock::API_HOSTNAME, 443)
         
     | 
| 
      
 12 
     | 
    
         
            +
                  @client.use_ssl = true
         
     | 
| 
       14 
13 
     | 
    
         | 
| 
       15 
14 
     | 
    
         
             
                  @client
         
     | 
| 
       16 
15 
     | 
    
         
             
                end
         
     | 
    
        data/lib/knock/objects.rb
    CHANGED
    
    | 
         @@ -363,6 +363,23 @@ module Knock 
     | 
|
| 
       363 
363 
     | 
    
         
             
                    execute_request(request: request)
         
     | 
| 
       364 
364 
     | 
    
         
             
                  end
         
     | 
| 
       365 
365 
     | 
    
         | 
| 
      
 366 
     | 
    
         
            +
                  # Creates a bulk operation to create subscriptions for a set recipients to
         
     | 
| 
      
 367 
     | 
    
         
            +
                  # a set of objects within the given collection.
         
     | 
| 
      
 368 
     | 
    
         
            +
                  #
         
     | 
| 
      
 369 
     | 
    
         
            +
                  # @param [String] collection The collection the objects are in.
         
     | 
| 
      
 370 
     | 
    
         
            +
                  # @param [Array<Hash>] subscriptions The set of subscriptions to create.
         
     | 
| 
      
 371 
     | 
    
         
            +
                  #
         
     | 
| 
      
 372 
     | 
    
         
            +
                  # @return [Hash] a BulkOperation
         
     | 
| 
      
 373 
     | 
    
         
            +
                  def bulk_add_subscriptions(collection:, subscriptions: [])
         
     | 
| 
      
 374 
     | 
    
         
            +
                    request = post_request(
         
     | 
| 
      
 375 
     | 
    
         
            +
                      auth: true,
         
     | 
| 
      
 376 
     | 
    
         
            +
                      path: "/v1/objects/#{collection}/bulk/subscriptions/add",
         
     | 
| 
      
 377 
     | 
    
         
            +
                      body: { subscriptions: subscriptions }
         
     | 
| 
      
 378 
     | 
    
         
            +
                    )
         
     | 
| 
      
 379 
     | 
    
         
            +
             
     | 
| 
      
 380 
     | 
    
         
            +
                    execute_request(request: request)
         
     | 
| 
      
 381 
     | 
    
         
            +
                  end
         
     | 
| 
      
 382 
     | 
    
         
            +
             
     | 
| 
       366 
383 
     | 
    
         
             
                  # Removes subscriptions for the recipients on the object
         
     | 
| 
       367 
384 
     | 
    
         
             
                  #
         
     | 
| 
       368 
385 
     | 
    
         
             
                  # @param [String] collection The collection the object is in
         
     | 
    
        data/lib/knock/version.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: knockapi
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 0.4. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 0.4.11
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - Knock Labs, Inc.
         
     | 
| 
       8 
     | 
    
         
            -
            autorequire: 
     | 
| 
      
 8 
     | 
    
         
            +
            autorequire:
         
     | 
| 
       9 
9 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       10 
10 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       11 
     | 
    
         
            -
            date: 2023- 
     | 
| 
      
 11 
     | 
    
         
            +
            date: 2023-09-11 00:00:00.000000000 Z
         
     | 
| 
       12 
12 
     | 
    
         
             
            dependencies:
         
     | 
| 
       13 
13 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       14 
14 
     | 
    
         
             
              name: bundler
         
     | 
| 
         @@ -66,6 +66,7 @@ files: 
     | 
|
| 
       66 
66 
     | 
    
         
             
            - ".gitignore"
         
     | 
| 
       67 
67 
     | 
    
         
             
            - ".rubocop.yml"
         
     | 
| 
       68 
68 
     | 
    
         
             
            - ".ruby-version"
         
     | 
| 
      
 69 
     | 
    
         
            +
            - ".tool-versions"
         
     | 
| 
       69 
70 
     | 
    
         
             
            - CONTRIBUTING.md
         
     | 
| 
       70 
71 
     | 
    
         
             
            - Gemfile
         
     | 
| 
       71 
72 
     | 
    
         
             
            - Gemfile.lock
         
     | 
| 
         @@ -92,7 +93,7 @@ licenses: 
     | 
|
| 
       92 
93 
     | 
    
         
             
            - MIT
         
     | 
| 
       93 
94 
     | 
    
         
             
            metadata:
         
     | 
| 
       94 
95 
     | 
    
         
             
              documentation_uri: https://docs.knock.app
         
     | 
| 
       95 
     | 
    
         
            -
            post_install_message: 
     | 
| 
      
 96 
     | 
    
         
            +
            post_install_message:
         
     | 
| 
       96 
97 
     | 
    
         
             
            rdoc_options: []
         
     | 
| 
       97 
98 
     | 
    
         
             
            require_paths:
         
     | 
| 
       98 
99 
     | 
    
         
             
            - lib
         
     | 
| 
         @@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement 
     | 
|
| 
       108 
109 
     | 
    
         
             
                  version: '0'
         
     | 
| 
       109 
110 
     | 
    
         
             
            requirements: []
         
     | 
| 
       110 
111 
     | 
    
         
             
            rubygems_version: 3.4.10
         
     | 
| 
       111 
     | 
    
         
            -
            signing_key: 
     | 
| 
      
 112 
     | 
    
         
            +
            signing_key:
         
     | 
| 
       112 
113 
     | 
    
         
             
            specification_version: 4
         
     | 
| 
       113 
114 
     | 
    
         
             
            summary: API client for Knock
         
     | 
| 
       114 
115 
     | 
    
         
             
            test_files:
         
     |