pixela 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3df84dc9f4591de4d69003caafb28e57d787a269dc70f9fed967d8787183579
-  data.tar.gz: 0e23cf942470fd6cbec58c8df6d157bc3bdd045cc7438162b67d170a241d327d
+  metadata.gz: 9c101809b9328378863924ee2adc9aef94dd543cf93db7dc4f21e4916a02f5af
+  data.tar.gz: 89f280b63c454a27d90ef20762c3f6ccd0c7b2b724097bb9bdd762268e08b257
 SHA512:
-  metadata.gz: d4abcca60067437ac06d9b6dc76b92bc10edf54eed1260412ab7570b8d18153d297908f7339bebe5fb41c91c1170bb636b6c8dd9791108201cea72035fca02c3
-  data.tar.gz: 36f6d832bfaf3b7a470ec39ef365a261180a7b34fededd5d0e196322807f1aa811db23f643ac6c29d5de4e426f110096478f8414d12f343c2fa8ea7f23e195f5
+  metadata.gz: bfb71e70e9d65a5da0c60104dfbab46dbface426054adaf93cebb6e74104091c67994afe7268b2ad03c39fa0ba3218be758f8e6152bea468d81af0be29d4531b
+  data.tar.gz: 82845eee4380ffc77297f441a6acd5c37604a24d7f9522a52abb3b5d22e4b4cb847f2bad4429159c8768344878e31d443e0d5429b8cebc192d114319c8b24444

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v2.1.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v2.2.0...master)
+
+## v2.2.0
+[full changelog](http://github.com/sue445/pixela/compare/v2.1.0...v2.2.0)
+
+* Add `Pixela::Client#get_graph_def` and `Pixela::Graph#def`
+  * https://github.com/sue445/pixela/pull/83
+  * https://github.com/a-know/Pixela/releases/tag/v1.21.0
+* Add `Pixela::Client#get_pixels` and `Pixela::Graph#pixels`
+  * https://github.com/sue445/pixela/pull/84
+  * https://github.com/a-know/Pixela/releases/tag/v1.21.0
 
 ## v2.1.0
 [full changelog](http://github.com/sue445/pixela/compare/v2.0.0...v2.1.0)

data/lib/pixela/client/graph_methods.rb

@@ -176,6 +176,32 @@ module Pixela::Client::GraphMethods
     res.pixels.map { |ymd| Date.parse(ymd) }
   end
 
+  # Get a Date list of Pixel registered in the graph specified by graphID.
+  #
+  # @param graph_id [String]
+  # @param from [Date] Specify the start position of the period.
+  # @param to   [Date] Specify the end position of the period.
+  #
+  # @return [Array<Hashie::Mash>]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/get-graph-pixels
+  #
+  # @example
+  #   client.get_pixels(graph_id: "test-graph", from: Date.new(2018, 1, 1), to: Date.new(2018, 12, 31))
+  def get_pixels(graph_id:, from: nil, to: nil)
+    params = {
+      from:     to_ymd(from),
+      to:       to_ymd(to),
+      withBody: true,
+    }
+
+    with_error_handling do
+      connection.get("users/#{username}/graphs/#{graph_id}/pixels", params.compact).body.pixels
+    end
+  end
+
   # Based on the registered information, get various statistics.
   #
   # @param graph_id [String]
@@ -214,4 +240,22 @@ module Pixela::Client::GraphMethods
 
   alias_method :start_stopwatch, :run_stopwatch
   alias_method :end_stopwatch,   :run_stopwatch
+
+  # Get a predefined pixelation graph definition.
+  #
+  # @param graph_id [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/get-a-graph-def
+  #
+  # @example
+  #   client.get_graph_def(graph_id: "test-graph")
+  def get_graph_def(graph_id:)
+    with_error_handling do
+      connection.get("users/#{username}/graphs/#{graph_id}/graph-def").body
+    end
+  end
 end

data/lib/pixela/graph.rb

@@ -149,6 +149,23 @@ module Pixela
       client.get_pixel_dates(graph_id: graph_id, from: from, to: to)
     end
 
+    # Get a Date list of Pixel registered in the graph specified by graphID.
+    #
+    # @param from [Date] Specify the start position of the period.
+    # @param to   [Date] Specify the end position of the period.
+    #
+    # @return [Array<Hashie::Mash>]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/get-graph-pixels
+    #
+    # @example
+    #   client.graph("test-graph").pixels(from: Date.new(2018, 1, 1), to: Date.new(2018, 12, 31))
+    def pixels(from: nil, to: nil)
+      client.get_pixels(graph_id: graph_id, from: from, to: to)
+    end
+
     # Based on the registered information, get various statistics.
     #
     # @return [Pixela::Response]
@@ -179,5 +196,21 @@ module Pixela
 
     alias_method :start_stopwatch, :run_stopwatch
     alias_method :end_stopwatch,   :run_stopwatch
+
+    # Get a predefined pixelation graph definition.
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/get-a-graph-def
+    #
+    # @example
+    #   client.graph("test-graph").def
+    def def
+      client.get_graph_def(graph_id: graph_id)
+    end
+
+    alias_method :definition, :def
   end
 end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - sue445
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -262,7 +262,7 @@ metadata:
   homepage_uri: https://github.com/sue445/pixela
   source_code_uri: https://github.com/sue445/pixela
   changelog_uri: https://github.com/sue445/pixela/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -278,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Pixela API client for Ruby
 test_files: []