pixela 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ad266dd772aa47bb3201ceeb05f8f68c5ec6aac5f9f42f6955065d36459214
-  data.tar.gz: 4d5431713d481a5115eedd74ec96507217420d260407d44576179b436df873ca
+  metadata.gz: 2294c4ab50d90e3081e699ad2c99b33b7a8e4c37e271fe061e45433910508080
+  data.tar.gz: 1421993d12f16a5243526cefa580a06a9c3415385297055af0223510c72bb095
 SHA512:
-  metadata.gz: ce88158d30ec96dbe366f37a944bd2227a816666459fcac18b36a975e8ff135995a7db4ddc25ad6b45dd802c6591cac54d0d2b07d5ea7accfa2ee7f018889f96
-  data.tar.gz: a93bf0966fbd6fefb7f8fe8101e20b30e951ff2ea2b9c55d61de8a434ad436bd96cb1a0904f7ebf79cbe4bfbe6b35eb2de142d9b561e8a4eec3aa98ce7ad75fa
+  metadata.gz: d35da5fef54b3493635999a382ccb473af3e98e46dee0f014f3dfbcf99eeae4068e8d25a81523ccf525661e94139ab0755b9768ce11be84db8d921c9e9d2757e
+  data.tar.gz: 907b8a988c388f3a40656173441e9f3727cbb869c8723313d4bbcb00c44b149a7e18d5a0a6ffd26ff0a5d90d429e69a694b1fb45093a2b17c0af03bdbd5436b8

data/.github/workflows/test.yml

@@ -30,6 +30,7 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
         gemfile:
           - faraday_2
 

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v3.3.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v3.5.0...master)
+
+## [v3.5.0](https://github.com/sue445/pixela/releases/tag/v3.5.0)
+[full changelog](http://github.com/sue445/pixela/compare/v3.4.0...v3.5.0)
+
+* Add `Pixela::Client::GraphMethods#get_graph_today` and `Pixela::Graph#today`
+  * https://github.com/sue445/pixela/pull/117
+  * https://github.com/a-know/Pixela/releases/tag/v1.32.0
+
+## [v3.4.0](https://github.com/sue445/pixela/releases/tag/v3.4.0)
+[full changelog](http://github.com/sue445/pixela/compare/v3.3.0...v3.4.0)
+
+* Add `appearance`, `less_than` and `greather_than` to `Pixela::Client::GraphMethods#graph_url` and `Pixela::Graph#url`
+  * https://github.com/sue445/pixela/pull/115
+  * https://github.com/a-know/Pixela/releases/tag/v1.30.0
 
 ## v3.3.0
 [full changelog](http://github.com/sue445/pixela/compare/v3.2.0...v3.3.0)

data/README.md

@@ -4,7 +4,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/pixela.svg)](https://badge.fury.io/rb/pixela)
 [![CI activity of pixela-gem](https://pixe.la/v1/users/sue445/graphs/pixela-gem-ci?mode=badge)](https://pixe.la/v1/users/sue445/graphs/pixela-gem-ci.html)
-[![Build Status](https://github.com/sue445/pixela/workflows/test/badge.svg?branch=master)](https://github.com/sue445/pixela/actions?query=workflow%3Atest)
+[![test](https://github.com/sue445/pixela/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/pixela/actions/workflows/test.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/4c6316222717ee809b57/maintainability)](https://codeclimate.com/github/sue445/pixela/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/sue445/pixela/badge.svg)](https://coveralls.io/github/sue445/pixela)
 

data/gemfiles/common.gemfile

@@ -2,3 +2,8 @@ if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.7.0")
   # unparser v0.6.5+ requires ruby 2.7.0+
   gem "unparser", "< 0.6.5"
 end
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.7.0")
+  # term-ansicolor 1.9.0+ doesn't work on Ruby < 2.7
+  gem "term-ansicolor", "< 1.9.0"
+end

data/lib/pixela/client/graph_methods.rb

@@ -55,9 +55,12 @@ module Pixela::Client::GraphMethods
 
   # Get graph url
   #
-  # @param graph_id [String]
-  # @param date     [Date,Time]
-  # @param mode     [String] e.g) `short`
+  # @param graph_id     [String]
+  # @param date         [Date,Time]
+  # @param mode         [String] e.g) `short`
+  # @param appearance   [String] e.g) `dark`
+  # @param less_than    [String]
+  # @param greater_than [String]
   #
   # @return [String]
   #
@@ -66,12 +69,15 @@ module Pixela::Client::GraphMethods
   # @example
   #   client.graph_url(graph_id: "test-graph")
   #   client.graph_url(graph_id: "test-graph", date: Date.new(2018, 3, 31), mode: "short")
-  def graph_url(graph_id:, date: nil, mode: nil)
+  def graph_url(graph_id:, date: nil, mode: nil, appearance: nil, less_than: nil, greater_than: nil)
     url = "#{Pixela::Client::API_ENDPOINT}/users/#{username}/graphs/#{graph_id}"
 
     params = Faraday::Utils::ParamsHash.new
     params[:date] = to_ymd(date) if date
     params[:mode] = mode if mode
+    params[:appearance] = appearance if appearance
+    params[:lessThan] = less_than if less_than
+    params[:greaterThan] = greater_than if greater_than
 
     url << "?#{params.to_query}" unless params.empty?
 
@@ -276,4 +282,28 @@ module Pixela::Client::GraphMethods
       connection.get("users/#{username}/graphs/#{graph_id}/latest").body
     end
   end
+
+  # This is an endpoint that responds with the Pixel of the day you requested this API.
+  #
+  # @param graph_id [String]
+  # @param return_empty [Boolean] Specifying `true` for this param will return an empty Pixel instead of `404 Not Found` if the Pixel is unregistered on the day of the request.
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/get-today-pixel
+  #
+  # @example
+  #   client.get_graph_today(graph_id: "test-graph", return_empty: true)
+  def get_graph_today(graph_id:, return_empty: false)
+    params = {}
+    if return_empty
+      params[:returnEmpty] = return_empty
+    end
+
+    with_error_handling do
+      connection.get("users/#{username}/graphs/#{graph_id}/today", params.compact).body
+    end
+  end
 end

data/lib/pixela/graph.rb

@@ -50,8 +50,11 @@ module Pixela
 
     # Get graph url
     #
-    # @param date [Date,Time]
-    # @param mode [String] e.g) `short`
+    # @param date         [Date,Time]
+    # @param mode         [String] e.g) `short`
+    # @param appearance   [String] e.g) `dark`
+    # @param less_than    [String]
+    # @param greater_than [String]
     #
     # @return [String]
     #
@@ -60,8 +63,8 @@ module Pixela
     # @example
     #   client.graph("test-graph").url
     #   client.graph("test-graph").url(date: Date.new(2018, 3, 31), mode: "short")
-    def url(date: nil, mode: nil)
-      client.graph_url(graph_id: graph_id, date: date, mode: mode)
+    def url(date: nil, mode: nil, appearance: nil, less_than: nil, greater_than: nil)
+      client.graph_url(graph_id: graph_id, date: date, mode: mode, appearance: appearance, less_than: less_than, greater_than: greater_than)
     end
 
     # Update predefined pixelation graph definitions.
@@ -258,5 +261,21 @@ module Pixela
     def latest
       client.get_graph_latest(graph_id: graph_id)
     end
+
+    # This is an endpoint that responds with the Pixel of the day you requested this API.
+    #
+    # @param return_empty [Boolean] Specifying `true` for this param will return an empty Pixel instead of `404 Not Found` if the Pixel is unregistered on the day of the request.
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/get-today-pixel
+    #
+    # @example
+    #   client.graph("test-graph").today(return_empty: true)
+    def today(return_empty: false)
+      client.get_graph_today(graph_id: graph_id, return_empty: return_empty)
+    end
   end
 end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "3.3.0"
+  VERSION = "3.5.0"
 end

data/pixela.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-parameterized"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "term-ansicolor", "!= 1.11.1" # ref. https://github.com/flori/term-ansicolor/issues/41
   spec.add_development_dependency "unparser", ">= 0.4.5"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "yard"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - sue445
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -164,6 +163,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.11.1
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -253,7 +266,6 @@ metadata:
   changelog_uri: https://github.com/sue445/pixela/blob/master/CHANGELOG.md
   documentation_uri: https://sue445.github.io/pixela/
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,8 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Pixela API client for Ruby
 test_files: []