pixela 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a19da817bef056e3d3cc66258e4bce7813bccdb9d8d6e185f0d348283c424c84
-  data.tar.gz: cdc62d67befebedfc0c4c4b60c777271d0cacf419b363568f7fd1a923715047d
+  metadata.gz: 6eb158057d65be208480f8b727cc4dd4f140e8b181e1ac679db576572c4059f5
+  data.tar.gz: 2dd2a0c983bbbedca697acd09f43dfe400010811982ab20a5b01b5f9dfb952b4
 SHA512:
-  metadata.gz: 80480cae33a1c20da25abdeca2e2162468b8a0bf0effded2d7ae3cf612cc8fd7aa96ef9149306e9b23e25101ad65894d9d9654e7a48125534b770d0dfd6978ff
-  data.tar.gz: 6d4ba1cfee75fa49a0c1cdb940437e47fdf6e02326ade8972c98ebbbe4f23274a2fdcd668474c5f7efaf68e4488641284ba9f21a78a403613b14cbcdcfc88bd8
+  metadata.gz: 2f7d11b7027cf125a407b7a162b7fd5a8e96849b82b59258dc2c7d23827921cc7ce848c776b0d4760bd6036953cc2566a71d18b79002d2f701933b4ec2f05797
+  data.tar.gz: 554e82c827ee5de2d5909c883b320cbf2d8e32de2ec5fce43151290a4f6a240d82c769a321b56fa1a265052b6ed5395547fe4cb3db53ab4fcfad5a335566258e

data/.github/workflows/test.yml

@@ -12,9 +12,6 @@ on:
   schedule:
     - cron: "0 10 * * 5" # JST 19:00 (Fri)
 
-env:
-  CI: "true"
-
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -22,20 +19,20 @@ jobs:
     container: ${{ matrix.ruby }}
 
     env:
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
 
     strategy:
       fail-fast: false
 
       matrix:
         ruby:
-          - ruby:2.4
-          - ruby:2.5
           - ruby:2.6
           - ruby:2.7
+          - ruby:3.0
+          - ruby:3.1
           - rubylang/ruby:master-nightly-bionic
         gemfile:
-          - faraday_1.gemfile
+          - faraday_2
         include:
           - ruby: rubylang/ruby:master-nightly-bionic
             allow_failures: "true"
@@ -43,7 +40,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-
       - name: Cache gemfiles/vendor/bundle
         uses: actions/cache@v1
         id: cache_gem
@@ -92,7 +88,7 @@ jobs:
         continue-on-error: true
 
       - name: Slack Notification (not success)
-        uses: homoluctus/slatify@master
+        uses: lazy-actions/slatify@master
         if: "! success()"
         continue-on-error: true
         with:
@@ -110,7 +106,7 @@ jobs:
 
     steps:
       - name: Slack Notification (success)
-        uses: homoluctus/slatify@master
+        uses: lazy-actions/slatify@master
         if: always()
         continue-on-error: true
         with:

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v2.0.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v3.0.0...master)
+
+## 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
+  * https://github.com/sue445/pixela/pull/91
+
+## v2.2.1
+[full changelog](http://github.com/sue445/pixela/compare/v2.2.0...v2.2.1)
+
+* Enable MFA requirement for gem releasing
+  * https://github.com/sue445/pixela/pull/88
+
+## 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)
+
+* Add `Pixela::Client#update_profile`
+  * https://github.com/sue445/pixela/pull/81
+  * https://github.com/a-know/Pixela/releases/tag/v1.20.0
 
 ## v2.0.0
 [full changelog](http://github.com/sue445/pixela/compare/v1.5.0...v2.0.0)

data/gemfiles/{faraday_1.gemfile → faraday_2.gemfile}

@@ -5,4 +5,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in pixela.gemspec
 gemspec path: "../"
 
-gem "faraday", "~> 1.0"
+gem "faraday", "~> 2.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/client/profile_methods.rb

@@ -0,0 +1,40 @@
+module Pixela::Client::ProfileMethods
+  # Updates the profile information for the user corresponding to username
+  #
+  # @param display_name        [String]
+  # @param gravatar_icon_email [String]
+  # @param title               [String]
+  # @param timezone            [String]
+  # @param about_url           [String]
+  # @param contribute_urls     [Array<String>]
+  # @param pinned_graph_id     [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/put-profile
+  #
+  # @example
+  #   client.update_profile(display_name: "a-know", gravatar_icon_email: "user@example.com", title: "my title", timezone: "Asia/Tokyo", about_url: "https://home.a-know.me", contribute_urls: ["https://pixe.la/","https://github.com/a-know/pi","https://blog.a-know.me/archive/category/Pixela"])
+  def update_profile(display_name: nil, gravatar_icon_email: nil, title: nil, timezone: nil,
+                     about_url: nil, contribute_urls: [], pinned_graph_id: nil)
+
+    params = {
+      displayName:       display_name,
+      gravatarIconEmail: gravatar_icon_email,
+      title:             title,
+      timezone:          timezone,
+      aboutURL:          about_url,
+      pinnedGraphID:     pinned_graph_id
+    }
+
+    unless contribute_urls.empty?
+      params[:contributeURLs] = contribute_urls
+    end
+
+    with_error_handling do
+      connection(endpoint: Pixela::Client::TOP_ENDPOINT).put("@#{username}", params.compact).body
+    end
+  end
+end

data/lib/pixela/client/user_methods.rb

@@ -21,7 +21,7 @@ module Pixela::Client::UserMethods
     }
 
     with_error_handling do
-      connection(default_headers).post("users", params).body
+      connection(request_headers: default_headers).post("users", params).body
     end
   end
 

data/lib/pixela/client/webhook_methods.rb

@@ -53,7 +53,7 @@ module Pixela::Client::WebhookMethods
   #   client.invoke_webhook(webhook_hash: "<webhookHash>")
   def invoke_webhook(webhook_hash:)
     with_error_handling do
-      connection(default_headers).post("users/#{username}/webhooks/#{webhook_hash}").body
+      connection(request_headers: default_headers).post("users/#{username}/webhooks/#{webhook_hash}").body
     end
   end
 

data/lib/pixela/client.rb

@@ -2,15 +2,18 @@ module Pixela
   class Client
     autoload :GraphMethods,        "pixela/client/graph_methods"
     autoload :PixelMethods,        "pixela/client/pixel_methods"
+    autoload :ProfileMethods,      "pixela/client/profile_methods"
     autoload :UserMethods,         "pixela/client/user_methods"
     autoload :WebhookMethods,      "pixela/client/webhook_methods"
 
     include GraphMethods
     include PixelMethods
+    include ProfileMethods
     include UserMethods
     include WebhookMethods
 
     API_ENDPOINT = "https://pixe.la/v1"
+    TOP_ENDPOINT = "https://pixe.la"
 
     # @!attribute [r] username
     # @return [String]
@@ -52,8 +55,8 @@ module Pixela
     # @param request_headers [Hash]
     #
     # @return [Faraday::Connection]
-    def connection(request_headers = user_token_headers)
-      Faraday.new(url: API_ENDPOINT, headers: request_headers) do |conn|
+    def connection(request_headers: user_token_headers, endpoint: API_ENDPOINT)
+      Faraday.new(url: endpoint, headers: request_headers) do |conn|
         conn.request :json
         conn.response :mashify, mash_class: Pixela::Response
         conn.response :json

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.0.0"
+  VERSION = "3.0.0"
 end

data/lib/pixela.rb

@@ -1,6 +1,6 @@
 require "pixela/version"
 require "faraday"
-require "faraday_middleware"
+require "faraday/mashify"
 require "faraday_curl"
 require "date"
 

data/pixela.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
     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."
@@ -34,12 +35,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
-  spec.add_dependency "faraday", ">= 1.0.0"
+  spec.add_dependency "faraday", ">= 2.0.0"
   spec.add_dependency "faraday_curl"
-  spec.add_dependency "faraday_middleware"
-  spec.add_dependency "hashie"
+  spec.add_dependency "faraday-mashify"
 
   spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "coveralls"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: faraday_curl
   requirement: !ruby/object:Gem::Requirement
@@ -39,21 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: hashie
+  name: faraday-mashify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -240,11 +226,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/faraday_1.gemfile
+- gemfiles/faraday_2.gemfile
 - lib/pixela.rb
 - lib/pixela/client.rb
 - lib/pixela/client/graph_methods.rb
 - lib/pixela/client/pixel_methods.rb
+- lib/pixela/client/profile_methods.rb
 - lib/pixela/client/user_methods.rb
 - lib/pixela/client/webhook_methods.rb
 - lib/pixela/configuration.rb
@@ -261,6 +248,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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -269,14 +257,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Pixela API client for Ruby