pixela 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eb158057d65be208480f8b727cc4dd4f140e8b181e1ac679db576572c4059f5
-  data.tar.gz: 2dd2a0c983bbbedca697acd09f43dfe400010811982ab20a5b01b5f9dfb952b4
+  metadata.gz: 8a336057a8b3d607b5bdce6259191278d1338995b5a68f3d44551bba1c3918fa
+  data.tar.gz: c63183b4a8484f6ac55841ef1362d103ab1e1aeeece0714f364c299239bd3872
 SHA512:
-  metadata.gz: 2f7d11b7027cf125a407b7a162b7fd5a8e96849b82b59258dc2c7d23827921cc7ce848c776b0d4760bd6036953cc2566a71d18b79002d2f701933b4ec2f05797
-  data.tar.gz: 554e82c827ee5de2d5909c883b320cbf2d8e32de2ec5fce43151290a4f6a240d82c769a321b56fa1a265052b6ed5395547fe4cb3db53ab4fcfad5a335566258e
+  metadata.gz: b3c14c121dd2df7e48f7f40d9639387685aca2e9925bf88af1803caf7941ce17ca89861615221b55ad7caed22cefe5eec908d953a0542988c814c6e8d50ef3f3
+  data.tar.gz: 80967736967c85edb89f6acfb41a713bd594e93f01874a1ddd9e7980ee6726e787297c7b0aa41944602b078227e5cfc5aa303137f12027944ff7c4c42bed05fb

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# c.f. https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - sue445

data/.github/workflows/pages.yml

@@ -0,0 +1,62 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - master
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - run: bundle exec yard
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@main
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: "*pages*"
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -16,8 +16,6 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
-    container: ${{ matrix.ruby }}
-
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
 
@@ -26,36 +24,24 @@ jobs:
 
       matrix:
         ruby:
-          - ruby:2.6
-          - ruby:2.7
-          - ruby:3.0
-          - ruby:3.1
-          - rubylang/ruby:master-nightly-bionic
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
         gemfile:
           - faraday_2
-        include:
-          - ruby: rubylang/ruby:master-nightly-bionic
-            allow_failures: "true"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Cache gemfiles/vendor/bundle
-        uses: actions/cache@v1
-        id: cache_gem
+      - uses: ruby/setup-ruby@v1
         with:
-          path: gemfiles/vendor/bundle
-          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ github.sha }}
-          restore-keys: |
-            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.gemfile }}-
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          cache-version: ${{ matrix.gemfile }}
 
-      - name: bundle update
-        run: |
-          set -xe
-          bundle config path vendor/bundle
-          bundle update --jobs $(nproc) --retry 3
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - run: bundle update --jobs $(nproc) --retry 3
 
       - name: Setup Code Climate Test Reporter
         uses: aktions/codeclimate-test-reporter@v1
@@ -64,11 +50,7 @@ jobs:
           command: before-build
         continue-on-error: true
 
-      - name: Run test
-        run: |
-          set -xe
-          bundle exec rspec
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - run: bundle exec rspec
 
       - name: Teardown Code Climate Test Reporter
         uses: aktions/codeclimate-test-reporter@v1

data/CHANGELOG.md

@@ -1,10 +1,24 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v3.0.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v3.2.0...master)
+
+## v3.2.0
+[full changelog](http://github.com/sue445/pixela/compare/v3.1.0...v3.2.0)
+
+* Add Impl `Pixela::Client::PixelMethods#create_pixels` and `Pixela::Pixel#create_multi`
+  * https://github.com/sue445/pixela/pull/105
+  * https://github.com/a-know/Pixela/releases/tag/v1.28.0
+
+## v3.1.0
+[full changelog](http://github.com/sue445/pixela/compare/v3.0.0...v3.1.0)
+
+* Add `Pixela::Client#add_pixel` and `Pixela::Client#subtract_pixel`
+  * https://github.com/sue445/pixela/pull/101
+  * https://github.com/a-know/Pixela/releases/tag/v1.26.0
 
 ## v3.0.0
 [full changelog](http://github.com/sue445/pixela/compare/v2.2.1...v3.0.0)
 
-* Support faraday v2+ and drop support ruby < 2.6
+* :bomb: **[BREAKING CHANGE]** Support faraday v2+ and drop support ruby < 2.6
   * https://github.com/sue445/pixela/pull/91
 
 ## v2.2.1

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in pixela.gemspec
 gemspec
+
+eval_gemfile "./gemfiles/common.gemfile"

data/README.md

@@ -57,7 +57,7 @@ client.graph("test-graph").pixel(Date.today).create(quantity: 5)
 
 All methods are followings
 
-https://www.rubydoc.info/gems/pixela/Pixela/Client
+https://sue445.github.io/pixela/Pixela/Client
 
 ## Configuration
 ```ruby

data/gemfiles/common.gemfile

@@ -0,0 +1,4 @@
+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

data/gemfiles/faraday_2.gemfile

@@ -5,4 +5,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in pixela.gemspec
 gemspec path: "../"
 
+eval_gemfile "./common.gemfile"
+
 gem "faraday", "~> 2.0"

data/lib/pixela/client/pixel_methods.rb

@@ -26,6 +26,33 @@ module Pixela::Client::PixelMethods
     end
   end
 
+  # This API is used to register multiple Pixels (quantities for a specific day) at a time.
+  #
+  # @param graph_id [String]
+  # @param pixels   [Array<Hash>] key: date, quantity, optional_data
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/batch-post-pixels
+  #
+  # @example
+  #   client.create_pixels(graph_id: "test-graph", pixels: [{date: Date.new(2018, 9, 15), quantity: 5, optional_data: {key: "value"}}])
+  def create_pixels(graph_id:, pixels:)
+    pixels = pixels.map do |pixel|
+      {
+        date:         to_ymd(pixel[:date]),
+        quantity:     pixel[:quantity].to_s,
+        optionalData: pixel[:optional_data]&.to_json,
+      }.compact
+    end
+
+    with_error_handling do
+      connection.post("users/#{username}/graphs/#{graph_id}/pixels", pixels).body
+    end
+  end
+
   # Get registered quantity as "Pixel".
   #
   # @param graph_id [String]
@@ -138,4 +165,50 @@ module Pixela::Client::PixelMethods
       connection.put("users/#{username}/graphs/#{graph_id}/decrement").body
     end
   end
+
+  # Add quantity to the "Pixel" of the day
+  #
+  # @param graph_id [String]
+  # @param quantity [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/add-pixel
+  #
+  # @example
+  #   client.add_pixel(graph_id: "test-graph", quantity: "1")
+  def add_pixel(graph_id:, quantity:)
+    params = {
+      quantity: quantity.to_s,
+    }
+
+    with_error_handling do
+      connection.put("users/#{username}/graphs/#{graph_id}/add", params.compact).body
+    end
+  end
+
+  # Subtract quantity from the "Pixel" of the day
+  #
+  # @param graph_id [String]
+  # @param quantity [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/subtract-pixel
+  #
+  # @example
+  #   client.subtract_pixel(graph_id: "test-graph", quantity: "1")
+  def subtract_pixel(graph_id:, quantity:)
+    params = {
+      quantity: quantity.to_s,
+    }
+
+    with_error_handling do
+      connection.put("users/#{username}/graphs/#{graph_id}/subtract", params.compact).body
+    end
+  end
 end

data/lib/pixela/graph.rb

@@ -132,6 +132,38 @@ module Pixela
       client.decrement_pixel(graph_id: graph_id)
     end
 
+    # Add quantity to the "Pixel" of the day
+    #
+    # @param quantity [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/add-pixel
+    #
+    # @example
+    #   client.graph("test-graph").add(quantity: "1")
+    def add(quantity:)
+      client.add_pixel(graph_id: graph_id, quantity: quantity)
+    end
+
+    # Subtract quantity from the "Pixel" of the day
+    #
+    # @param quantity [String]
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/subtract-pixel
+    #
+    # @example
+    #   client.graph("test-graph").subtract(quantity: "1")
+    def subtract(quantity:)
+      client.subtract_pixel(graph_id: graph_id, quantity: quantity)
+    end
+
     # Get a Date list of Pixel registered in the graph specified by graphID.
     #
     # @param from [Date] Specify the start position of the period.

data/lib/pixela/pixel.rb

@@ -38,6 +38,22 @@ module Pixela
       client.create_pixel(graph_id: graph_id, date: date, quantity: quantity, optional_data: optional_data)
     end
 
+    # This API is used to register multiple Pixels (quantities for a specific day) at a time.
+    #
+    # @param pixels [Array<Hash>] key: date, quantity, optional_data
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/batch-post-pixels
+    #
+    # @example
+    #   client.graph("test-graph").create_multi(pixels: [{date: Date.new(2018, 9, 15), quantity: 5, optional_data: {key: "value"}}])
+    def create_multi(pixels:)
+      client.create_pixels(graph_id: graph_id, pixels: pixels)
+    end
+
     # Get registered quantity as "Pixel".
     #
     # @return [Pixela::Response]

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "3.0.0"
+  VERSION = "3.2.0"
 end

data/pixela.gemspec

@@ -14,17 +14,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sue445/pixela"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
-    spec.metadata["rubygems_mfa_required"] = "true"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://sue445.github.io/pixela/"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -42,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-mashify"
 
   spec.add_development_dependency "bundler", ">= 1.16"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "coveralls_reborn"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -215,6 +215,8 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".env.example"
+- ".github/dependabot.yml"
+- ".github/workflows/pages.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -226,6 +228,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/common.gemfile
 - gemfiles/faraday_2.gemfile
 - lib/pixela.rb
 - lib/pixela/client.rb
@@ -248,6 +251,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
+  documentation_uri: https://sue445.github.io/pixela/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -264,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Pixela API client for Ruby