pixela 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9efdafcfea7a90985336604bc68755a79ca200ad48f0682ce5a274f6bb23238
-  data.tar.gz: 6eb16f9eef42f1fc9f3983759b4819776ce18acba486680f4e620892097c5b7c
+  metadata.gz: a19da817bef056e3d3cc66258e4bce7813bccdb9d8d6e185f0d348283c424c84
+  data.tar.gz: cdc62d67befebedfc0c4c4b60c777271d0cacf419b363568f7fd1a923715047d
 SHA512:
-  metadata.gz: 8727d06117b6ca73c52ce02afc0231f44582a7a7a7c9c70f943036d59041b71497023076191cc08a320fe9cfa0037336c99ade3aa2e9bb1353d49afef46baf4c
-  data.tar.gz: d7348691f57c02d3d4fdfb55157d1f637a802df67fd39719f984e96db9005e0c6281b795848e0a7417e4e9c15c24754bfc8a2f7a98065b7f538b7fac31a804a3
+  metadata.gz: 80480cae33a1c20da25abdeca2e2162468b8a0bf0effded2d7ae3cf612cc8fd7aa96ef9149306e9b23e25101ad65894d9d9654e7a48125534b770d0dfd6978ff
+  data.tar.gz: 6d4ba1cfee75fa49a0c1cdb940437e47fdf6e02326ade8972c98ebbbe4f23274a2fdcd668474c5f7efaf68e4488641284ba9f21a78a403613b14cbcdcfc88bd8

data/.github/workflows/test.yml

@@ -0,0 +1,121 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "0 10 * * 5" # JST 19:00 (Fri)
+
+env:
+  CI: "true"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    container: ${{ matrix.ruby }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - ruby:2.4
+          - ruby:2.5
+          - ruby:2.6
+          - ruby:2.7
+          - rubylang/ruby:master-nightly-bionic
+        gemfile:
+          - faraday_1.gemfile
+        include:
+          - ruby: rubylang/ruby:master-nightly-bionic
+            allow_failures: "true"
+
+    steps:
+      - uses: actions/checkout@v2
+
+
+      - name: Cache gemfiles/vendor/bundle
+        uses: actions/cache@v1
+        id: cache_gem
+        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' }}
+
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - name: Setup Code Climate Test Reporter
+        uses: aktions/codeclimate-test-reporter@v1
+        with:
+          codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
+          command: before-build
+        continue-on-error: true
+
+      - name: Run test
+        run: |
+          set -xe
+          bundle exec rspec
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - name: Teardown Code Climate Test Reporter
+        uses: aktions/codeclimate-test-reporter@v1
+        with:
+          codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
+          command: after-build
+        continue-on-error: true
+
+      - name: Invoke Pixela webhook
+        run: |
+          if [ -n "$PIXELA_WEBHOOK_URL" ]; then
+            curl -X POST $PIXELA_WEBHOOK_URL -H 'Content-Length:0'
+          fi
+        env:
+          PIXELA_WEBHOOK_URL: ${{ secrets.PIXELA_WEBHOOK_URL }}
+        if: always()
+        continue-on-error: true
+
+      - name: Slack Notification (not success)
+        uses: homoluctus/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*build* ({0}, {1})', matrix.ruby, matrix.gemfile) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  notify:
+    needs:
+      - test
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Slack Notification (success)
+        uses: homoluctus/slatify@master
+        if: always()
+        continue-on-error: true
+        with:
+          job_name: '*build*'
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -10,5 +10,5 @@
 # rspec failure tracking
 .rspec_status
 
-Gemfile.lock
+*.lock
 .env

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v1.3.1...master)
+[full changelog](http://github.com/sue445/pixela/compare/v2.0.0...master)
+
+## v2.0.0
+[full changelog](http://github.com/sue445/pixela/compare/v1.5.0...v2.0.0)
+
+### :warning: Breaking changes :warning:
+* Remove Channel and Notification
+  * https://github.com/sue445/pixela/pull/75
+  * https://github.com/a-know/Pixela/releases/tag/v1.19.0
+* Drop support for faraday v0.x
+  * https://github.com/sue445/pixela/pull/77
+* Drop support for ruby 2.3
+  * https://github.com/sue445/pixela/pull/78
+
+## v1.5.0
+[full changelog](http://github.com/sue445/pixela/compare/v1.4.2...v1.5.0)
+
+* Add `Pixela::Client#run_stopwatch` and `Pixela::Graph#run_stopwatch`
+  * https://github.com/sue445/pixela/pull/74
+  * https://github.com/a-know/Pixela/releases/tag/v1.18.0
+
+## v1.4.2
+[full changelog](http://github.com/sue445/pixela/compare/v1.4.1...v1.4.2)
+
+* Support `remind_by` of Notification
+  * https://github.com/sue445/pixela/pull/72
+  * https://github.com/a-know/Pixela/releases/tag/v1.17.0
+
+## v1.4.1
+[full changelog](http://github.com/sue445/pixela/compare/v1.4.0...v1.4.1)
+
+* Support faraday v1.0
+  * https://github.com/sue445/pixela/pull/63
+
+## v1.4.0
+[full changelog](http://github.com/sue445/pixela/compare/v1.3.1...v1.4.0)
+
+* Support Channel and Notification API
+  * https://github.com/sue445/pixela/pull/59
+  * https://github.com/a-know/Pixela/releases/tag/v1.13.0
 
 ## v1.3.1
 [full changelog](http://github.com/sue445/pixela/compare/v1.3.0...v1.3.1)

data/README.md

@@ -3,7 +3,8 @@
 [Pixela](https://pixe.la/) API client for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/pixela.svg)](https://badge.fury.io/rb/pixela)
-[![Build Status](https://travis-ci.org/sue445/pixela.svg?branch=master)](https://travis-ci.org/sue445/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)
 [![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/bin/console

@@ -13,5 +13,5 @@ Dotenv.load
 
 Pixela.config.debug_logger = Logger.new(STDOUT)
 
-require "pry"
-Pry.start
+require "irb"
+IRB.start

data/gemfiles/faraday_1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pixela.gemspec
+gemspec path: "../"
+
+gem "faraday", "~> 1.0"

data/lib/pixela/client.rb

@@ -1,9 +1,9 @@
 module Pixela
   class Client
-    autoload :GraphMethods,   "pixela/client/graph_methods"
-    autoload :PixelMethods,   "pixela/client/pixel_methods"
-    autoload :UserMethods,    "pixela/client/user_methods"
-    autoload :WebhookMethods, "pixela/client/webhook_methods"
+    autoload :GraphMethods,        "pixela/client/graph_methods"
+    autoload :PixelMethods,        "pixela/client/pixel_methods"
+    autoload :UserMethods,         "pixela/client/user_methods"
+    autoload :WebhookMethods,      "pixela/client/webhook_methods"
 
     include GraphMethods
     include PixelMethods
@@ -70,7 +70,7 @@ module Pixela
 
     def with_error_handling
       yield
-    rescue Faraday::ClientError => error
+    rescue Faraday::ClientError, Faraday::ServerError => error
       begin
         body = JSON.parse(error.response[:body])
         raise PixelaError, body["message"]
@@ -99,10 +99,5 @@ module Pixela
 
       date.strftime("%Y%m%d")
     end
-
-    def compact_hash(hash)
-      # NOTE: Hash#compact is available since MRI 2.4+
-      hash.reject { |_, v| v.nil? }
-    end
   end
 end

data/lib/pixela/client/graph_methods.rb

@@ -33,7 +33,7 @@ module Pixela::Client::GraphMethods
     }
 
     with_error_handling do
-      connection.post("users/#{username}/graphs", compact_hash(params)).body
+      connection.post("users/#{username}/graphs", params.compact).body
     end
   end
 
@@ -126,7 +126,7 @@ module Pixela::Client::GraphMethods
     end
 
     with_error_handling do
-      connection.put("users/#{username}/graphs/#{graph_id}", compact_hash(params)).body
+      connection.put("users/#{username}/graphs/#{graph_id}", params.compact).body
     end
   end
 
@@ -170,7 +170,7 @@ module Pixela::Client::GraphMethods
 
     res =
       with_error_handling do
-        connection.get("users/#{username}/graphs/#{graph_id}/pixels", compact_hash(params)).body
+        connection.get("users/#{username}/graphs/#{graph_id}/pixels", params.compact).body
       end
 
     res.pixels.map { |ymd| Date.parse(ymd) }
@@ -193,4 +193,25 @@ module Pixela::Client::GraphMethods
       connection.get("users/#{username}/graphs/#{graph_id}/stats").body
     end
   end
+
+  # This will start and end the measurement of the time.
+  #
+  # @param graph_id [String]
+  #
+  # @return [Pixela::Response]
+  #
+  # @raise [Pixela::PixelaError] API is failed
+  #
+  # @see https://docs.pixe.la/entry/post-stopwatch
+  #
+  # @example
+  #   client.run_stopwatch(graph_id: "test-graph")
+  def run_stopwatch(graph_id:)
+    with_error_handling do
+      connection.post("users/#{username}/graphs/#{graph_id}/stopwatch").body
+    end
+  end
+
+  alias_method :start_stopwatch, :run_stopwatch
+  alias_method :end_stopwatch,   :run_stopwatch
 end

data/lib/pixela/client/pixel_methods.rb

@@ -22,7 +22,7 @@ module Pixela::Client::PixelMethods
     }
 
     with_error_handling do
-      connection.post("users/#{username}/graphs/#{graph_id}", compact_hash(params)).body
+      connection.post("users/#{username}/graphs/#{graph_id}", params.compact).body
     end
   end
 
@@ -80,7 +80,7 @@ module Pixela::Client::PixelMethods
     }
 
     with_error_handling do
-      connection.put("users/#{username}/graphs/#{graph_id}/#{to_ymd(date)}", compact_hash(params)).body
+      connection.put("users/#{username}/graphs/#{graph_id}/#{to_ymd(date)}", params.compact).body
     end
   end
 

data/lib/pixela/graph.rb

@@ -162,5 +162,22 @@ module Pixela
     def stats
       client.get_graph_stats(graph_id: graph_id)
     end
+
+    # This will start and end the measurement of the time.
+    #
+    # @return [Pixela::Response]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://docs.pixe.la/entry/post-stopwatch
+    #
+    # @example
+    #   client.graph("test-graph").run_stopwatch
+    def run_stopwatch
+      client.run_stopwatch(graph_id: graph_id)
+    end
+
+    alias_method :start_stopwatch, :run_stopwatch
+    alias_method :end_stopwatch,   :run_stopwatch
   end
 end

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "1.3.1"
+  VERSION = "2.0.0"
 end

data/pixela.gemspec

@@ -34,9 +34,9 @@ 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.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_dependency "faraday"
+  spec.add_dependency "faraday", ">= 1.0.0"
   spec.add_dependency "faraday_curl"
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "hashie"
@@ -44,12 +44,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-parameterized"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "unparser", ">= 0.4.5"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - sue445
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: faraday_curl
   requirement: !ruby/object:Gem::Requirement
@@ -108,32 +108,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -192,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -229,9 +229,9 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".env.example"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -240,6 +240,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/faraday_1.gemfile
 - lib/pixela.rb
 - lib/pixela/client.rb
 - lib/pixela/client/graph_methods.rb
@@ -260,7 +261,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
@@ -268,15 +269,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Pixela API client for Ruby
 test_files: []

data/.travis.yml

@@ -1,40 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-bundler_args: "--jobs=2"
-cache: bundler
-before_install:
-  - travis_retry gem update --system || travis_retry gem update --system 2.7.8
-  - travis_retry gem install bundler --no-document || travis_retry gem install bundler --no-document -v 1.17.3
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - if [ "$PIXELA_WEBHOOK_URL" != "" ]; then curl -X POST $PIXELA_WEBHOOK_URL -H 'Content-Length:0'; fi
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-branches:
-  only:
-    - master
-notifications:
-  email: false
-  slack:
-    secure: ec/Q9tFK+TjW7ZVOWg8NPfa4IFfbU24ljqObG7YhlaYaIN63MMdMITfy17sQahm2T0x7jhAzxDo1pDTb9XoBs12cu2wogZltv+daZwATWYzipvUxQqge1yywnFn3QLfQyzAl5p1MYkxLpJeVDRD8wunmc2OikR4jMtl5KDk9e2sItHGJdfPY8mFhM+sKaLyy9mbGo02aqRqwhgXGFQg1lZ/D6qPZKPSAd+S+uJgma8En4P292APBN9hsgpjC4HGqiqhPumOyjmdiVZ//4QoYhIEaMGJiwKyv9GwS0cTfk6w9MNFRILhj4tN3kP8ZsI7h5oQy8+x0Deac9joTKMNVarvZkVFZWLZ3p8mthdsRNKZeYxkSgnrhwA/3CFe/THjolfROA61iQqWxFycdIqSieiGHZ57EvHo7HOSD5Kc0017X+UITjiWiKiSQPddPmYm5hl9lo9rBo1RaJRr6B5A2qrw2SBmNfH38+BDTMFZprJLN51LBJ4DEy4R0CClbyIk6DbODsWqQC+W+6sOCWOhrVXSeSVlxPz7hT24ezkcMLMvoA5k9f6Gi2cWWDD9CmRI2Upt+5lx0Ui1/9xbk4RG6/hue8L764jdQ2mqNtrAZJSjdfs9KxapoKFllezdwhNVJS4UoU6PT9DU227cHH3SWHYm9GHu/pQ6kdhBGcr/EMiY=
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  include:
-    - rvm: 2.6
-      env: RUBYOPT="--jit"
-    - rvm: ruby-head
-      env: RUBYOPT="--jit"
-sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=67b1bed21e42834690bb57b148b93d6bd23410d8e013afdf6a89d66f36011a95