pixela 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25fbb20e23770f6f80aa0f64c4deb5a307b3b51fa085d509e33a6f4515eac047
-  data.tar.gz: 86718c3b950f1478e0381480ae3ceab903b2be5cd32a4593999b36763b4b7d73
+  metadata.gz: 0bdf58874af8d488cace583d00efc11a2bda3e095fe5ee4b9f4afaf83bbaab00
+  data.tar.gz: 44b273ab85f3761f72619b839785d95aa6b8d2b8945abef19ff2cdde24d887fc
 SHA512:
-  metadata.gz: c4a7061a46d3830d0e1fa9b0436920d7f751412ca1ff57ae34bdbfd991220d15c4707e46e3b67976b0f261d8bb13f338c0a3e01985a387ab2754b00c642d7a94
-  data.tar.gz: 774ea1249452fa072547fe1dd667298cf61cbc1328837150202918c5b9fdda0d94307cb257ffe0d77ec60f43d0adcf87cc96ea8a1808f324aa87461b1a532e6a
+  metadata.gz: adebc2de07fd39ada466ccf27edbbaed2ae47b5ec16b984265a5ffc91e2280a08807dfd0a279790a4a29a5c63c04598d0e1b5c714f69bbb8eafb80fbb32718e7
+  data.tar.gz: 8c487b204b5e8a2d0417bc210c4c21a2f8812b6ff1e72159118b470464bbe8b4f409a1f85f60df0916945faba9f8b5dbd9cd9fa732c3380a20fa0f48093a540c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v0.3.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v0.4.0...master)
+
+## v0.4.0
+[full changelog](http://github.com/sue445/pixela/compare/v0.3.0...v0.4.0)
+
+* Support webhook API
+  * https://github.com/sue445/pixela/issues/23
+  * https://github.com/sue445/pixela/pull/24
 
 ## v0.3.0
 [full changelog](http://github.com/sue445/pixela/compare/v0.2.0...v0.3.0)

data/lib/pixela.rb

@@ -9,6 +9,7 @@ module Pixela
   autoload :Configuration, "pixela/configuration"
   autoload :Graph,         "pixela/graph"
   autoload :Pixel,         "pixela/pixel"
+  autoload :Webhook,       "pixela/webhook"
 
   # @return [Pixela::Configuration]
   def self.config

data/lib/pixela/client.rb

@@ -1,12 +1,14 @@
 module Pixela
   class Client
-    autoload :GraphMethods, "pixela/client/graph_methods"
-    autoload :PixelMethods, "pixela/client/pixel_methods"
-    autoload :UserMethods,  "pixela/client/user_methods"
+    autoload :GraphMethods,   "pixela/client/graph_methods"
+    autoload :PixelMethods,   "pixela/client/pixel_methods"
+    autoload :UserMethods,    "pixela/client/user_methods"
+    autoload :WebhookMethods, "pixela/client/webhook_methods"
 
     include GraphMethods
     include PixelMethods
     include UserMethods
+    include WebhookMethods
 
     API_ENDPOINT = "https://pixe.la/v1"
 
@@ -34,6 +36,13 @@ module Pixela
       Graph.new(client: self, graph_id: graph_id)
     end
 
+    # @param webhook_hash [String]
+    #
+    # @return [Pixela::Webhook]
+    def webhook(webhook_hash)
+      Webhook.new(client: self, webhook_hash: webhook_hash)
+    end
+
     private
 
     # @!attribute [r] token

data/lib/pixela/client/webhook_methods.rb

@@ -0,0 +1,77 @@
+module Pixela::Client::WebhookMethods
+  # Create a new Webhook.
+  #
+  # @param graph_id [String]
+  # @param type     [String]
+  #
+  # @return [Hashie::Mash]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://pixe.la/#api-webhook
+  #
+  # @example
+  #   client.create_webhook(graph_id: "test-graph", type: "increment")
+  def create_webhook(graph_id:, type:)
+    params = {
+      graphID: graph_id,
+      type:    type,
+    }
+
+    with_error_handling do
+      connection.post("users/#{username}/webhooks", params, user_token_headers).body
+    end
+  end
+
+  # Get all predefined webhooks definitions.
+  #
+  # @return [Array<Hashie::Mash>]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://pixe.la/#api-webhook
+  #
+  # @example
+  #   client.get_webhooks
+  def get_webhooks
+    with_error_handling do
+      connection.get("users/#{username}/webhooks", nil, user_token_headers).body.webhooks
+    end
+  end
+
+  # Invoke the webhook registered in advance.
+  #
+  # @param webhook_hash [String]
+  #
+  # @return [Hashie::Mash]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://pixe.la/#api-webhook
+  #
+  # @example
+  #   client.invoke_webhook(webhook_hash: "<webhookHash>")
+  def invoke_webhook(webhook_hash:)
+    with_error_handling do
+      connection.post("users/#{username}/webhooks/#{webhook_hash}", nil, default_headers).body
+    end
+  end
+
+  # Delete the registered Webhook.
+  #
+  # @param webhook_hash [String]
+  #
+  # @return [Hashie::Mash]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://pixe.la/#api-webhook
+  #
+  # @example
+  #   client.delete_webhook(webhook_hash: "<webhookHash>")
+  def delete_webhook(webhook_hash:)
+    with_error_handling do
+      connection.delete("users/#{username}/webhooks/#{webhook_hash}", nil, user_token_headers).body
+    end
+  end
+end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/pixela/webhook.rb

@@ -0,0 +1,46 @@
+module Pixela
+  class Webhook
+    # @!attribute [r] client
+    # @return [Pixela::Client]
+    attr_reader :client
+
+    # @!attribute [r] webhook_hash
+    # @return [String]
+    attr_reader :webhook_hash
+
+    # @param client       [Pixela::Client]
+    # @param webhook_hash [String]
+    def initialize(client:, webhook_hash:)
+      @client       = client
+      @webhook_hash = webhook_hash
+    end
+
+    # Invoke the webhook registered in advance.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-webhook
+    #
+    # @example
+    #   client.webhook("<webhookHash>").invoke
+    def invoke
+      client.invoke_webhook(webhook_hash: webhook_hash)
+    end
+
+    # Delete the registered Webhook.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-webhook
+    #
+    # @example
+    #   client.webhook("<webhookHash>").delete
+    def delete
+      client.delete_webhook(webhook_hash: webhook_hash)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -245,10 +245,12 @@ files:
 - lib/pixela/client/graph_methods.rb
 - lib/pixela/client/pixel_methods.rb
 - lib/pixela/client/user_methods.rb
+- lib/pixela/client/webhook_methods.rb
 - lib/pixela/configuration.rb
 - lib/pixela/graph.rb
 - lib/pixela/pixel.rb
 - lib/pixela/version.rb
+- lib/pixela/webhook.rb
 - pixela.gemspec
 homepage: https://github.com/sue445/pixela
 licenses: