pixela 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbd9c38bce70da0d2342696429f2134f5fe83dc3d1ce78700a5e0495b34b64fa
-  data.tar.gz: dc1595b8c1933918359afcc20071b8bc9cf4fa14228cb7bbab75ac587a2c339e
+  metadata.gz: 1e324737e723e18a31a7f909771be43a3f12528375747c3d5c2eb40389f3243d
+  data.tar.gz: e2b59967a4f5a79d4278f9982bfe23b7fd70b2af18acc29653d185052936cd7d
 SHA512:
-  metadata.gz: 5602f7337b1c274af570a02f53ada0c77f010254dd4ede21098c4127f1cc73ab94155c2b286ca186d9e9657476acbb28755ca03bc62a028ac68171bae98fa12b
-  data.tar.gz: a0931a40c579bb7cb26b3d80a901850426c4e651f3741e0cd7692c96aeaa9d42939187c66694cebb6fc571e197e24d370d2919de39f6e9b6a05ff3790ea48e29
+  metadata.gz: 4b7d41ba7582b77f39872a2fb91ff30beb3b8849c90b08172569db68c48290aecfe3fc3eadd1ff69fad590252760088eee3608c05127a02fe44f4c82645dd675
+  data.tar.gz: 10cf6d6778b51c4890faaf8c1f1e2a8ef16679beef4030b389c86dad2d46a717c551edc8cd483a3810544c9c45280aad770428788d702c0d1d08a2e8bdb3c6f7

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v0.1.0...master)
+[full changelog](http://github.com/sue445/pixela/compare/v0.1.1...master)
+
+## v0.1.1
+[full changelog](http://github.com/sue445/pixela/compare/v0.1.0...v0.1.1)
+
+* Add default value to date args
+  * https://github.com/sue445/pixela/pull/14
 
 ## v0.1.0
 * first release

data/README.md

@@ -2,6 +2,7 @@
 
 [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)
 [![Maintainability](https://api.codeclimate.com/v1/badges/4c6316222717ee809b57/maintainability)](https://codeclimate.com/github/sue445/pixela/maintainability)
 
@@ -41,7 +42,14 @@ client.create_pixel(graph_id: "test-graph", date: Date.today, quantity: 5)
 
 All methods are followings
 
-https://www.rubydoc.info/gems/pixela
+https://www.rubydoc.info/gems/pixela/Pixela/Client
+
+## Configuration
+```ruby
+Pixela.config.debug_logger = Logger.new(STDOUT)
+```
+
+* `debug_logger`: Enable debug logging if `Logger` is set
 
 ## Development
 

data/lib/pixela.rb

@@ -2,14 +2,15 @@ require "pixela/version"
 require "faraday"
 require "faraday_middleware"
 require "faraday_curl"
+require "date"
 
 module Pixela
-  autoload :Client,    "pixela/client"
-  autoload :Configure, "pixela/configure"
+  autoload :Client,        "pixela/client"
+  autoload :Configuration, "pixela/configuration"
 
-  # @return [Pixela::Configure]
+  # @return [Pixela::Configuration]
   def self.config
-    @config ||= Configure.new
+    @config ||= Configuration.new
   end
 
   class PixelaError < StandardError

data/lib/pixela/client.rb

@@ -10,6 +10,8 @@ module Pixela
 
     API_ENDPOINT = "https://pixe.la/v1"
 
+    # @!attribute [r] username
+    # @return [String]
     attr_reader :username
 
     # @param username [String]
@@ -27,6 +29,8 @@ module Pixela
 
     private
 
+    # @!attribute [r] token
+    # @return [String]
     attr_reader :token
 
     def connection

data/lib/pixela/client/graph_methods.rb

@@ -9,6 +9,8 @@ module Pixela::Client::GraphMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-graph
   def create_graph(graph_id:, name:, unit:, type:, color:)
     params = {
@@ -28,6 +30,8 @@ module Pixela::Client::GraphMethods
   #
   # @return [Array<Hashie::Mash>]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-graph
   def get_graphs
     with_error_handling do
@@ -38,13 +42,15 @@ module Pixela::Client::GraphMethods
   # Get graph url
   #
   # @param graph_id [String]
-  # @param date     [Date,Time,String]
+  # @param date     [Date,Time]
   #
   # @return [String]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-graph
   def graph_url(graph_id:, date: nil)
-    url = "https://pixe.la/v1/users/#{username}/graphs/#{graph_id}"
+    url = "#{Pixela::Client::API_ENDPOINT}/users/#{username}/graphs/#{graph_id}"
 
     url << "?date=#{to_ymd(date)}" if date
 
@@ -60,6 +66,8 @@ module Pixela::Client::GraphMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-graph
   def update_graph(graph_id:, name:, unit:, color:)
     params = {
@@ -79,6 +87,8 @@ module Pixela::Client::GraphMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-graph
   def delete_graph(graph_id)
     with_error_handling do

data/lib/pixela/client/pixel_methods.rb

@@ -7,8 +7,10 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
-  def create_pixel(graph_id:, date:, quantity:)
+  def create_pixel(graph_id:, date: Date.today, quantity:)
     params = {
       date:     to_ymd(date),
       quantity: quantity.to_s,
@@ -26,8 +28,10 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
-  def get_pixel(graph_id:, date:)
+  def get_pixel(graph_id:, date: Date.today)
     with_error_handling do
       connection.get("users/#{username}/graphs/#{graph_id}/#{to_ymd(date)}", nil, user_token_headers).body
     end
@@ -41,8 +45,10 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
-  def update_pixel(graph_id:, date:, quantity:)
+  def update_pixel(graph_id:, date: Date.today, quantity:)
     params = {
       quantity: quantity.to_s,
     }
@@ -59,8 +65,10 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
-  def delete_pixel(graph_id:, date:)
+  def delete_pixel(graph_id:, date: Date.today)
     with_error_handling do
       connection.delete("users/#{username}/graphs/#{graph_id}/#{to_ymd(date)}", nil, user_token_headers).body
     end
@@ -72,6 +80,8 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
   def increment_pixel(graph_id:)
     with_error_handling do
@@ -85,6 +95,8 @@ module Pixela::Client::PixelMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-pixel
   def decrement_pixel(graph_id:)
     with_error_handling do

data/lib/pixela/client/user_methods.rb

@@ -6,6 +6,8 @@ module Pixela::Client::UserMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-user
   def create_user(agree_terms_of_service:, not_minor:)
     params = {
@@ -26,6 +28,8 @@ module Pixela::Client::UserMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-user
   def update_user(new_token:)
     params = {
@@ -46,6 +50,8 @@ module Pixela::Client::UserMethods
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-user
   def delete_user
     with_error_handling do

data/lib/pixela/{configure.rb → configuration.rb}

@@ -1,5 +1,5 @@
 module Pixela
-  class Configure
+  class Configuration
     # @!attribute debug_logger
     #   @return [Logger]
     attr_accessor :debug_logger

data/lib/pixela/version.rb

@@ -1,3 +1,3 @@
 module Pixela
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/pixela.gemspec

@@ -49,4 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sue445
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: Pixela API client for Ruby
 email:
 - sue445@sue445.net
@@ -217,6 +231,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -229,7 +244,7 @@ files:
 - lib/pixela/client/graph_methods.rb
 - lib/pixela/client/pixel_methods.rb
 - lib/pixela/client/user_methods.rb
-- lib/pixela/configure.rb
+- lib/pixela/configuration.rb
 - lib/pixela/version.rb
 - pixela.gemspec
 homepage: https://github.com/sue445/pixela