pixela 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9efdafcfea7a90985336604bc68755a79ca200ad48f0682ce5a274f6bb23238
-  data.tar.gz: 6eb16f9eef42f1fc9f3983759b4819776ce18acba486680f4e620892097c5b7c
+  metadata.gz: 375d6ec8ab2c9c4be2747ba45a7c820ced86af17de33af609d9dd1113838b029
+  data.tar.gz: daf59f70e4899e6bb62dd3ea3f2f1e8406d9de8172b47e22b90a462d1cceee2e
 SHA512:
-  metadata.gz: 8727d06117b6ca73c52ce02afc0231f44582a7a7a7c9c70f943036d59041b71497023076191cc08a320fe9cfa0037336c99ade3aa2e9bb1353d49afef46baf4c
-  data.tar.gz: d7348691f57c02d3d4fdfb55157d1f637a802df67fd39719f984e96db9005e0c6281b795848e0a7417e4e9c15c24754bfc8a2f7a98065b7f538b7fac31a804a3
+  metadata.gz: 44f9c7ff48301f987d0978320fe637b4881680f9c18afecd5034ca475c1207fd23a11113f21588ad596f0e6018f213bfc70902b4d91043c144ba87bb07f367ad
+  data.tar.gz: ac91d230a786cba5a1a3599fa9cb4ade64a2965dd1c3086be6a57ea9997c02af8937363e246da7d14e9518fa5ead6591767f533ed23f6b32da56562145801349

data/.travis.yml

@@ -15,7 +15,7 @@ before_script:
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
 script:
-  - bundle exec rspec
+  - RUBYOPT=$RSPEC_RUBYOPT bundle exec rspec
 after_script:
   - if [ "$PIXELA_WEBHOOK_URL" != "" ]; then curl -X POST $PIXELA_WEBHOOK_URL -H 'Content-Length:0'; fi
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
@@ -31,9 +31,9 @@ matrix:
     - rvm: ruby-head
   include:
     - rvm: 2.6
-      env: RUBYOPT="--jit"
+      env: RSPEC_RUBYOPT="--jit"
     - rvm: ruby-head
-      env: RUBYOPT="--jit"
+      env: RSPEC_RUBYOPT="--jit"
 sudo: false
 env:
   global:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v1.3.1...master)
+[full changelog](http://github.com/sue445/pixela/compare/v1.4.0...master)
+
+## v1.4.0
+[full changelog](http://github.com/sue445/pixela/compare/v1.3.1...v1.4.0)
+
+* Support Channel and Notification API
+  * https://github.com/sue445/pixela/pull/59
+  * https://github.com/a-know/Pixela/releases/tag/v1.13.0
 
 ## v1.3.1
 [full changelog](http://github.com/sue445/pixela/compare/v1.3.0...v1.3.1)

data/lib/pixela.rb

@@ -5,9 +5,11 @@ require "faraday_curl"
 require "date"
 
 module Pixela
+  autoload :Channel,       "pixela/channel"
   autoload :Client,        "pixela/client"
   autoload :Configuration, "pixela/configuration"
   autoload :Graph,         "pixela/graph"
+  autoload :Notification,  "pixela/notification"
   autoload :Pixel,         "pixela/pixel"
   autoload :Response,      "pixela/response"
   autoload :Webhook,       "pixela/webhook"

data/lib/pixela/channel.rb

@@ -0,0 +1,106 @@
+module Pixela
+  class Channel
+    # @!attribute [r] client
+    # @return [Pixela::Client]
+    attr_reader :client
+
+    # @!attribute [r] id
+    # @return [String]
+    attr_reader :channel_id
+
+    # @param client [Pixela::Client]
+    # @param graph_id [String]
+    def initialize(client:, channel_id:)
+      @client = client
+      @channel_id = channel_id
+    end
+
+    # Create a new channel settings for notification.
+    #
+    # @param name [String]
+    # @param type [String]
+    # @param detail [Hash]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/post-channel
+    #
+    # @example
+    #   client.channel("my-channel").create(name: "My slack channel", type: "slack", detail: {url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", userName: "Pixela Notification", channelName: "pixela-notify"})
+    def create(name:, type:, detail:)
+      client.create_channel(channel_id: channel_id, name: name, type: type, detail: detail)
+    end
+
+    # Create a new channel settings for slack notification.
+    #
+    # @param name [String]
+    # @param url [String]
+    # @param user_name [String]
+    # @param channel_name [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/post-channel
+    #
+    # @example
+    #   client.channel("my-channel").create_with_slack(name: "My slack channel", url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", user_name: "Pixela Notification", channel_name: "pixela-notify")
+    def create_with_slack(name:, url:, user_name:, channel_name:)
+      client.create_slack_channel(channel_id: channel_id, name: name, url: url, user_name: user_name, channel_name: channel_name)
+    end
+
+    # Update predefined channel settings.
+    #
+    # @param name [String]
+    # @param type [String]
+    # @param detail [Hash]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/put-channel
+    #
+    # @example
+    #   client.channel("my-channel").update(name: "My slack channel", type: "slack", detail: {url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", userName: "Pixela Notification", channelName: "pixela-notify"})
+    def update(name:, type:, detail:)
+      client.update_channel(channel_id: channel_id, name: name, type: type, detail: detail)
+    end
+
+    # Update predefined slack channel settings.
+    #
+    # @param name [String]
+    # @param url [String]
+    # @param user_name [String]
+    # @param channel_name [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/post-channel
+    #
+    # @example
+    #   client.channel("my-channel").update_with_slack(name: "My slack channel", url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", user_name: "Pixela Notification", channel_name: "pixela-notify")
+    def update_with_slack(name:, url:, user_name:, channel_name:)
+      client.update_slack_channel(channel_id: channel_id, name: name, url: url, user_name: user_name, channel_name: channel_name)
+    end
+
+    # Delete predefined channel settings.
+    #
+    # @see https://docs.pixe.la/entry/delete-channel
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @example
+    #   client.channel("my-channel").delete
+    def delete
+      client.delete_channel(channel_id: channel_id)
+    end
+  end
+end

data/lib/pixela/client.rb

@@ -1,11 +1,15 @@
 module Pixela
   class Client
-    autoload :GraphMethods,   "pixela/client/graph_methods"
-    autoload :PixelMethods,   "pixela/client/pixel_methods"
-    autoload :UserMethods,    "pixela/client/user_methods"
-    autoload :WebhookMethods, "pixela/client/webhook_methods"
-
+    autoload :ChannelMethods,      "pixela/client/channel_methods"
+    autoload :GraphMethods,        "pixela/client/graph_methods"
+    autoload :NotificationMethods, "pixela/client/notificaton_methods"
+    autoload :PixelMethods,        "pixela/client/pixel_methods"
+    autoload :UserMethods,         "pixela/client/user_methods"
+    autoload :WebhookMethods,      "pixela/client/webhook_methods"
+
+    include ChannelMethods
     include GraphMethods
+    include NotificationMethods
     include PixelMethods
     include UserMethods
     include WebhookMethods
@@ -43,6 +47,13 @@ module Pixela
       Webhook.new(client: self, webhook_hash: webhook_hash)
     end
 
+    # @param channel_id [String]
+    #
+    # @return [Pixela::Channel]
+    def channel(channel_id)
+      Channel.new(client: self, channel_id: channel_id)
+    end
+
     private
 
     # @!attribute [r] token

data/lib/pixela/client/channel_methods.rb

@@ -0,0 +1,148 @@
+module Pixela::Client::ChannelMethods
+  # Create a new channel settings for notification.
+  #
+  # @param channel_id [String]
+  # @param name [String]
+  # @param type [String]
+  # @param detail [Hash]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/post-channel
+  #
+  # @example
+  #   client.create_channel(channel_id: "my-channel", name: "My slack channel", type: "slack", detail: {url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", userName: "Pixela Notification", channelName: "pixela-notify"})
+  def create_channel(channel_id:, name:, type:, detail:)
+    params = {
+      id:     channel_id,
+      name:   name,
+      type:   type,
+      detail: detail,
+    }
+
+    with_error_handling do
+      connection.post("users/#{username}/channels", compact_hash(params)).body
+    end
+  end
+
+  # Create a new channel settings for slack notification.
+  #
+  # @param channel_id [String]
+  # @param name [String]
+  # @param url [String]
+  # @param user_name [String]
+  # @param channel_name [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/post-channel
+  #
+  # @example
+  #   client.create_slack_channel(channel_id: "my-channel", name: "My slack channel", url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", user_name: "Pixela Notification", channel_name: "pixela-notify")
+  def create_slack_channel(channel_id:, name:, url:, user_name:, channel_name:)
+    create_channel(
+      channel_id: channel_id,
+      name: name,
+      type: "slack",
+      detail: {
+        url:         url,
+        userName:    user_name,
+        channelName: channel_name,
+      },
+    )
+  end
+
+  # Get all predefined channels.
+  #
+  # @see https://docs.pixe.la/entry/get-channels
+  #
+  # @return [Array<Pixela::Response>]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @example
+  #   client.get_channels
+  def get_channels
+    with_error_handling do
+      connection.get("users/#{username}/channels").body.channels
+    end
+  end
+
+  # Update predefined channel settings.
+  #
+  # @param channel_id [String]
+  # @param name [String]
+  # @param type [String]
+  # @param detail [Hash]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/put-channel
+  #
+  # @example
+  #   client.update_channel(channel_id: "my-channel", name: "My slack channel", type: "slack", detail: {url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", userName: "Pixela Notification", channelName: "pixela-notify"})
+  def update_channel(channel_id:, name:, type:, detail:)
+    params = {
+      name:   name,
+      type:   type,
+      detail: detail,
+    }
+
+    with_error_handling do
+      connection.put("users/#{username}/channels/#{channel_id}", compact_hash(params)).body
+    end
+  end
+
+  # Update predefined slack channel settings.
+  #
+  # @param channel_id [String]
+  # @param name [String]
+  # @param url [String]
+  # @param user_name [String]
+  # @param channel_name [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/post-channel
+  #
+  # @example
+  #   client.update_slack_channel(channel_id: "my-channel", name: "My slack channel", url: "https://hooks.slack.com/services/T035DA4QD/B06LMAV40/xxxx", user_name: "Pixela Notification", channel_name: "pixela-notify")
+  def update_slack_channel(channel_id:, name:, url:, user_name:, channel_name:)
+    update_channel(
+      channel_id: channel_id,
+      name: name,
+      type: "slack",
+      detail: {
+        url:         url,
+        userName:    user_name,
+        channelName: channel_name,
+      },
+    )
+  end
+
+  # Delete predefined channel settings.
+  #
+  # @param channel_id [String]
+  #
+  # @see https://docs.pixe.la/entry/delete-channel
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @example
+  #   client.delete_channel(channel_id: "my-channel")
+  def delete_channel(channel_id:)
+    with_error_handling do
+      connection.delete("users/#{username}/channels/#{channel_id}").body
+    end
+  end
+end

data/lib/pixela/client/notificaton_methods.rb

@@ -0,0 +1,103 @@
+module Pixela::Client::NotificationMethods
+  # Create a notification rule.
+  #
+  # @param graph_id [String]
+  # @param notification_id [String]
+  # @param name [String]
+  # @param target [String]
+  # @param condition [String]
+  # @param threshold [String]
+  # @param channel_id [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/post-notification
+  #
+  # @example
+  #   client.create_notification(graph_id: "test-graph", notification_id: "my-notification-rule", name: "my notification rule", target: "quantity", condition: ">", threshold: "5", channel_id: "my-channel")
+  def create_notification(graph_id:, notification_id:, name:, target:, condition:, threshold:, channel_id:)
+    params = {
+      id: notification_id,
+      name: name,
+      target: target,
+      condition: condition,
+      threshold: threshold,
+      channelID: channel_id,
+    }
+
+    with_error_handling do
+      connection.post("users/#{username}/graphs/#{graph_id}/notifications", compact_hash(params)).body
+    end
+  end
+
+  # Get all predefined notifications.
+  #
+  # @param graph_id [String]
+  #
+  # @return [Array<Pixela::Response>]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/get-notifications
+  #
+  # @example
+  #   client.get_notifications(graph_id: "test-graph")
+  def get_notifications(graph_id:)
+    with_error_handling do
+      connection.get("users/#{username}/graphs/#{graph_id}/notifications").body.notifications
+    end
+  end
+
+  # Update predefined notification rule.
+  #
+  # @param graph_id [String]
+  # @param notification_id [String]
+  # @param name [String]
+  # @param target [String]
+  # @param condition [String]
+  # @param threshold [String]
+  # @param channel_id [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/put-notification
+  #
+  # @example
+  #   client.update_notification(graph_id: "test-graph", notification_id: "my-notification-rule", name: "my notification rule", target: "quantity", condition: ">", threshold: "5", channel_id: "my-channel")
+  def update_notification(graph_id:, notification_id:, name:, target:, condition:, threshold:, channel_id:)
+    params = {
+      name: name,
+      target: target,
+      condition: condition,
+      threshold: threshold,
+      channelID: channel_id,
+    }
+
+    with_error_handling do
+      connection.put("users/#{username}/graphs/#{graph_id}/notifications/#{notification_id}", compact_hash(params)).body
+    end
+  end
+
+  # Delete predefined notification settings.
+  #
+  # @param graph_id [String]
+  # @param notification_id [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/delete-notification
+  #
+  # @example
+  #   client.delete_notification(graph_id: "test-graph", notification_id: "my-notification-rule")
+  def delete_notification(graph_id:, notification_id:)
+    with_error_handling do
+      connection.delete("users/#{username}/graphs/#{graph_id}/notifications/#{notification_id}").body
+    end
+  end
+end

data/lib/pixela/graph.rb

@@ -22,6 +22,13 @@ module Pixela
       Pixel.new(client: client, graph_id: graph_id, date: date)
     end
 
+    # @param notification_id [String]
+    #
+    # @return [Pixela::Notification]
+    def notification(notification_id)
+      Notification.new(client: client, graph_id: graph_id, notification_id: notification_id)
+    end
+
     # Create a new pixelation graph definition.
     #
     # @param name                  [String]

data/lib/pixela/notification.rb

@@ -0,0 +1,80 @@
+module Pixela
+  class Notification
+    # @!attribute [r] client
+    # @return [Pixela::Client]
+    attr_reader :client
+
+    # @!attribute [r] graph_id
+    # @return [String]
+    attr_reader :graph_id
+
+    # @!attribute [r] notification_id
+    # @return [String]
+    attr_reader :notification_id
+
+    # @param client          [Pixela::Client]
+    # @param graph_id        [String]
+    # @param notification_id [String]
+    def initialize(client:, graph_id:, notification_id:)
+      @client          = client
+      @graph_id        = graph_id
+      @notification_id = notification_id
+    end
+
+    # Create a notification rule.
+    #
+    # @param name [String]
+    # @param target [String]
+    # @param condition [String]
+    # @param threshold [String]
+    # @param channel_id [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/post-notification
+    #
+    # @example
+    #   client.graph("test-graph").notification("my-notification-rule").create(name: "my notification rule", target: "quantity", condition: ">", threshold: "5", channel_id: "my-channel")
+    def create(name:, target:, condition:, threshold:, channel_id:)
+      client.create_notification(graph_id: graph_id, notification_id: notification_id, name: name, target: target, condition: condition, threshold: threshold, channel_id: channel_id)
+    end
+
+    # Update predefined notification rule.
+    #
+    # @param graph_id [String]
+    # @param notification_id [String]
+    # @param name [String]
+    # @param target [String]
+    # @param condition [String]
+    # @param threshold [String]
+    # @param channel_id [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/put-notification
+    #
+    # @example
+    #   client.graph("test-graph").notification("my-notification-rule").update(name: "my notification rule", target: "quantity", condition: ">", threshold: "5", channel_id: "my-channel")
+    def update(name:, target:, condition:, threshold:, channel_id:)
+      client.update_notification(graph_id: graph_id, notification_id: notification_id, name: name, target: target, condition: condition, threshold: threshold, channel_id: channel_id)
+    end
+
+    # Delete predefined notification settings.
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/delete-notification
+    #
+    # @example
+    #   client.graph("test-graph").notification("my-notification-rule").delete
+    def delete
+      client.delete_notification(graph_id: graph_id, notification_id: notification_id)
+    end
+  end
+end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -241,13 +241,17 @@ files:
 - bin/console
 - bin/setup
 - lib/pixela.rb
+- lib/pixela/channel.rb
 - lib/pixela/client.rb
+- lib/pixela/client/channel_methods.rb
 - lib/pixela/client/graph_methods.rb
+- lib/pixela/client/notificaton_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/notification.rb
 - lib/pixela/pixel.rb
 - lib/pixela/response.rb
 - lib/pixela/version.rb
@@ -275,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Pixela API client for Ruby