pixela 3.4.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84863e1784b461eabfb1ae36666416fc7cf37c8ca2951a3a464b20f3821ff777
-  data.tar.gz: 8da17e92b6c7a6597429894031836bf37203ef26df8222985abce978629f93e0
+  metadata.gz: 3d39bdd23220713711c3d2ecbc65e66b95f874f71d8987e3b4ae02449db614c8
+  data.tar.gz: 48b0efd0a4c8e30f0d0bdbe6610eb7c215e0e5385dc99aa8f9d31100af87896f
 SHA512:
-  metadata.gz: bea0ab88f494152ac7e15ba5bd59bab5cd66a3e9c8b19c88ccd02c2e0d82e01777700ec7a89e500c9598ac899b2f13accc878d7254c82bdd341704f320a9269f
-  data.tar.gz: 84a72a29e516a3ff59b19183c065ad80eb063d36954a42758a932d98e1022c1aee9936a53841c238208b3ce29ae9ad697df6a2693447bf65248c5c1223fb58c8
+  metadata.gz: 61efb3ed1806ea747a5d8356260eade052bbc03bb672be5d991a54ececf26928f11a8f2d2c21e762b93353deae3f231b90e4215b349a75c485c96c79d7827be9
+  data.tar.gz: 2f6295b3edc28e817d6c51248bbf22663a82af3db73da0c335a6112378a1cc9a38bd064f33d076317b9dbadadb8db79e2812816798ff64a1f9d03801b104c57c

data/.github/dependabot.yml

@@ -6,5 +6,7 @@ updates:
     directory: /
     schedule:
       interval: weekly
+    cooldown:
+      default-days: 7
     assignees:
       - sue445

data/.github/workflows/pages.yml

@@ -30,9 +30,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
         with:
           ruby-version: ruby
           bundler-cache: true
@@ -40,18 +40,18 @@ jobs:
       - run: bundle exec yard
 
       - name: Setup Pages
-        uses: actions/configure-pages@v5
+        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
         with:
           # Upload entire repository
           path: './doc'
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@main
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
 
       - name: Slack Notification (not success)
-        uses: act10ns/slack@v2
+        uses: act10ns/slack@cfcc30955fe9377f4f55e1079e5419ee1014269f # v2
         if: "! success()"
         continue-on-error: true
         with:

data/.github/workflows/release_gem.yml

@@ -0,0 +1,41 @@
+name: Publish gem to rubygems.org
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    if: github.repository == 'sue445/pixela'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/pixela
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@eaecf785f6a34567a6d97f686bbb7bccc1ac1e5c # v1.237.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -30,13 +30,14 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
         gemfile:
           - faraday_2
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
@@ -45,7 +46,7 @@ jobs:
       - run: bundle update --jobs $(nproc) --retry 3
 
       - name: Setup Code Climate Test Reporter
-        uses: aktions/codeclimate-test-reporter@v1
+        uses: aktions/codeclimate-test-reporter@7634aa9ac7883182f583f15ff7b6ff519939dd0a # v1.2.0
         with:
           codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
           command: before-build
@@ -54,7 +55,7 @@ jobs:
       - run: bundle exec rspec
 
       - name: Teardown Code Climate Test Reporter
-        uses: aktions/codeclimate-test-reporter@v1
+        uses: aktions/codeclimate-test-reporter@7634aa9ac7883182f583f15ff7b6ff519939dd0a # v1.2.0
         with:
           codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
           command: after-build
@@ -71,7 +72,7 @@ jobs:
         continue-on-error: true
 
       - name: Slack Notification (not success)
-        uses: act10ns/slack@v2
+        uses: act10ns/slack@cfcc30955fe9377f4f55e1079e5419ee1014269f # v2
         if: "! success()"
         continue-on-error: true
         with:
@@ -87,7 +88,7 @@ jobs:
 
     steps:
       - name: Slack Notification (success)
-        uses: act10ns/slack@v2
+        uses: act10ns/slack@cfcc30955fe9377f4f55e1079e5419ee1014269f # v2
         if: always()
         continue-on-error: true
         with:

data/CHANGELOG.md

@@ -1,7 +1,20 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v3.4.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v3.5.1...master)
 
-## v3.4.0
+## [v3.5.1](https://github.com/sue445/pixela/releases/tag/v3.5.1)
+[full changelog](http://github.com/sue445/pixela/compare/v3.5.0...v3.5.1)
+
+* Release gem from GitHub Actions
+  * https://github.com/sue445/pixela/pull/122
+
+## [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`

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/lib/pixela/client/graph_methods.rb

@@ -282,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

@@ -261,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/response.rb

@@ -1,6 +1,21 @@
+# @!parse
+#   module Hashie
+#     # @see https://www.rubydoc.info/gems/hashie/Hashie/Hash
+#     class Hash < ::Hash
+#     end
+#
+#     # @see https://www.rubydoc.info/gems/hashie/Hashie/Mash
+#     class Mash < Hash
+#     end
+#   end
+
 module Pixela
   require "hashie/mash"
 
+  # Pixela API response
+  #
+  # @see https://www.rubydoc.info/gems/hashie/Hashie/Hash
+  # @see https://www.rubydoc.info/gems/hashie/Hashie/Mash
   class Response < Hashie::Mash
     disable_warnings
   end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "3.4.0"
+  VERSION = "3.5.1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.1
 platform: ruby
 authors:
 - sue445
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -231,6 +230,7 @@ files:
 - ".env.example"
 - ".github/dependabot.yml"
 - ".github/workflows/pages.yml"
+- ".github/workflows/release_gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -267,7 +267,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
@@ -282,8 +281,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.7
 specification_version: 4
 summary: Pixela API client for Ruby
 test_files: []