pixela 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e324737e723e18a31a7f909771be43a3f12528375747c3d5c2eb40389f3243d
-  data.tar.gz: e2b59967a4f5a79d4278f9982bfe23b7fd70b2af18acc29653d185052936cd7d
+  metadata.gz: 245d38a5c8da2a19b31e3d621bab11be044147077ddc1d8926ce8cae228152be
+  data.tar.gz: 378bf2f361bbf229c93142175f7365389273a9f0cafaa7dbaedf0eeeb14af943
 SHA512:
-  metadata.gz: 4b7d41ba7582b77f39872a2fb91ff30beb3b8849c90b08172569db68c48290aecfe3fc3eadd1ff69fad590252760088eee3608c05127a02fe44f4c82645dd675
-  data.tar.gz: 10cf6d6778b51c4890faaf8c1f1e2a8ef16679beef4030b389c86dad2d46a717c551edc8cd483a3810544c9c45280aad770428788d702c0d1d08a2e8bdb3c6f7
+  metadata.gz: 57847e630f6b0c341cd8ba1ca75df3d23fbe8948cb4d36c8e947299d9c55818f94fe1ff81ecfa7462f1fd645aa92e0869c51c33b07ac3de8a42ecd782de46443
+  data.tar.gz: 62f09e06bb0654249d494b216b467c2e27c821e227b670d1befb035047033c976fd1c41be4ae7712c54b2e9891bd1cc2cf1e2cb056c0a373155c7a5534c99958

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: Q6A7yXGKoFD4xsC1GFAacIyLiIK9mV0JK

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
-[full changelog](http://github.com/sue445/pixela/compare/v0.1.1...master)
+[full changelog](http://github.com/sue445/pixela/compare/v0.2.0...master)
+
+## v0.2.0
+[full changelog](http://github.com/sue445/pixela/compare/v0.1.1...v0.2.0)
+
+* Impl resource methods
+  * https://github.com/sue445/pixela/pull/17
 
 ## v0.1.1
 [full changelog](http://github.com/sue445/pixela/compare/v0.1.0...v0.1.1)

data/README.md

@@ -5,6 +5,7 @@
 [![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)
+[![Coverage Status](https://coveralls.io/repos/github/sue445/pixela/badge.svg)](https://coveralls.io/github/sue445/pixela)
 
 ## Installation
 

data/lib/pixela.rb

@@ -7,6 +7,8 @@ require "date"
 module Pixela
   autoload :Client,        "pixela/client"
   autoload :Configuration, "pixela/configuration"
+  autoload :Graph,         "pixela/graph"
+  autoload :Pixel,         "pixela/pixel"
 
   # @return [Pixela::Configuration]
   def self.config

data/lib/pixela/client.rb

@@ -27,6 +27,13 @@ module Pixela
       %Q(#<Pixela::Client:0x#{"%016X" % object_id} @username="#{username}">)
     end
 
+    # @param graph_id [String]
+    #
+    # @return [Pixela::Graph]
+    def graph(graph_id)
+      Graph.new(client: self, graph_id: graph_id)
+    end
+
     private
 
     # @!attribute [r] token

data/lib/pixela/client/graph_methods.rb

@@ -12,6 +12,9 @@ module Pixela::Client::GraphMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-graph
+  #
+  # @example
+  #   client.create_graph(graph_id: "test-graph", name: "graph-name", unit: "commit", type: "int", color: "shibafu")
   def create_graph(graph_id:, name:, unit:, type:, color:)
     params = {
       id:    graph_id,
@@ -33,6 +36,9 @@ module Pixela::Client::GraphMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-graph
+  #
+  # @example
+  #   client.get_graphs
   def get_graphs
     with_error_handling do
       connection.get("users/#{username}/graphs", nil, user_token_headers).body.graphs
@@ -46,9 +52,11 @@ module Pixela::Client::GraphMethods
   #
   # @return [String]
   #
-  # @raise [Pixela::PixelaError] API is failed
-  #
   # @see https://pixe.la/#api-graph
+  #
+  # @example
+  #   client.graph_url(graph_id: "test-graph")
+  #   client.graph_url(graph_id: "test-graph", date: Date.new(2018, 3, 31))
   def graph_url(graph_id:, date: nil)
     url = "#{Pixela::Client::API_ENDPOINT}/users/#{username}/graphs/#{graph_id}"
 
@@ -69,6 +77,9 @@ module Pixela::Client::GraphMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-graph
+  #
+  # @example
+  #   client.update_graph(graph_id: "test-graph", name: "graph-name", unit: "commit", color: "shibafu")
   def update_graph(graph_id:, name:, unit:, color:)
     params = {
       name:  name,
@@ -90,6 +101,9 @@ module Pixela::Client::GraphMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-graph
+  #
+  # @example
+  #   client.delete_graph("test-graph")
   def delete_graph(graph_id)
     with_error_handling do
       connection.delete("users/#{username}/graphs/#{graph_id}", nil, user_token_headers).body

data/lib/pixela/client/pixel_methods.rb

@@ -10,6 +10,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.create_pixel(graph_id: "test-graph", date: Date.new(2018, 9, 15), quantity: 5)
   def create_pixel(graph_id:, date: Date.today, quantity:)
     params = {
       date:     to_ymd(date),
@@ -31,6 +34,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.get_pixel(graph_id: "test-graph", date: Date.new(2018, 9, 15))
   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
@@ -48,6 +54,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.update_pixel(graph_id: "test-graph", date: Date.new(2018, 9, 15), quantity: 7)
   def update_pixel(graph_id:, date: Date.today, quantity:)
     params = {
       quantity: quantity.to_s,
@@ -68,6 +77,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.delete_pixel(graph_id: "test-graph", date: Date.new(2018, 9, 15))
   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
@@ -83,6 +95,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.increment_pixel(graph_id: "test-graph")
   def increment_pixel(graph_id:)
     with_error_handling do
       connection.put("users/#{username}/graphs/#{graph_id}/increment", nil, user_token_headers).body
@@ -98,6 +113,9 @@ module Pixela::Client::PixelMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-pixel
+  #
+  # @example
+  #   client.decrement_pixel(graph_id: "test-graph")
   def decrement_pixel(graph_id:)
     with_error_handling do
       connection.put("users/#{username}/graphs/#{graph_id}/decrement", nil, user_token_headers).body

data/lib/pixela/client/user_methods.rb

@@ -9,6 +9,9 @@ module Pixela::Client::UserMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-user
+  #
+  # @example
+  #   client.create_user(agree_terms_of_service: true, not_minor: true)
   def create_user(agree_terms_of_service:, not_minor:)
     params = {
       token:               token,
@@ -31,6 +34,9 @@ module Pixela::Client::UserMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-user
+  #
+  # @example
+  #   client.update_user(new_token: "thisissecret")
   def update_user(new_token:)
     params = {
       newToken: new_token,
@@ -53,6 +59,9 @@ module Pixela::Client::UserMethods
   # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-user
+  #
+  # @example
+  #   client.delete_user
   def delete_user
     with_error_handling do
       connection.delete("users/#{username}", nil, user_token_headers).body

data/lib/pixela/graph.rb

@@ -0,0 +1,105 @@
+module Pixela
+  class Graph
+    # @!attribute [r] client
+    # @return [Pixela::Client]
+    attr_reader :client
+
+    # @!attribute [r] graph_id
+    # @return [String]
+    attr_reader :graph_id
+
+    # @param client [Pixela::Client]
+    # @param graph_id [String]
+    def initialize(client:, graph_id:)
+      @client   = client
+      @graph_id = graph_id
+    end
+
+    # @param date [Date,Time]
+    #
+    # @return [Pixela::Pixel]
+    def pixel(date = Date.today)
+      Pixel.new(client: client, graph_id: graph_id, date: date)
+    end
+
+    # Create a new pixelation graph definition.
+    #
+    # @param name  [String]
+    # @param unit  [String]
+    # @param type  [String]
+    # @param color [String]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-graph
+    #
+    # @example
+    #   client.graph("test-graph").create(name: "graph-name", unit: "commit", type: "int", color: "shibafu")
+    def create(name:, unit:, type:, color:)
+      client.create_graph(graph_id: graph_id, name: name, unit: unit, type: type, color: color)
+    end
+
+    # Get graph url
+    #
+    # @param date [Date,Time]
+    #
+    # @return [String]
+    #
+    # @see https://pixe.la/#api-graph
+    #
+    # @example
+    #   client.graph("test-graph").url
+    #   client.graph("test-graph").url(date: Date.new(2018, 3, 31))
+    def url(date: nil)
+      client.graph_url(graph_id: graph_id, date: date)
+    end
+
+    # Update predefined pixelation graph definitions.
+    #
+    # @param name  [String]
+    # @param unit  [String]
+    # @param color [String]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-graph
+    #
+    # @example
+    #   client.graph("test-graph").update(name: "graph-name", unit: "commit", color: "shibafu")
+    def update(name:, unit:, color:)
+      client.update_graph(graph_id: graph_id, name: name, unit: unit, color: color)
+    end
+
+    # Increment quantity "Pixel" of the day (UTC).
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").increment
+    def increment
+      client.increment_pixel(graph_id: graph_id)
+    end
+
+    # Decrement quantity "Pixel" of the day (UTC).
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").decrement
+    def decrement
+      client.decrement_pixel(graph_id: graph_id)
+    end
+  end
+end

data/lib/pixela/pixel.rb

@@ -0,0 +1,84 @@
+module Pixela
+  class Pixel
+    # @!attribute [r] client
+    # @return [Pixela::Client]
+    attr_reader :client
+
+    # @!attribute [r] graph_id
+    # @return [String]
+    attr_reader :graph_id
+
+    # @!attribute [r] date
+    # @return [Date]
+    attr_reader :date
+
+    # @param client   [Pixela::Client]
+    # @param graph_id [String]
+    # @param date     [Date,Time]
+    def initialize(client:, graph_id:, date:)
+      @client   = client
+      @graph_id = graph_id
+      @date     = date
+    end
+
+    # It records the quantity of the specified date as a "Pixel".
+    #
+    # @param quantity [Integer,Float]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").pixel(Date.new(2018, 9, 15)).create(quantity: 5)
+    def create(quantity:)
+      client.create_pixel(graph_id: graph_id, date: date, quantity: quantity)
+    end
+
+    # Get registered quantity as "Pixel".
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").pixel(Date.new(2018, 9, 15)).get
+    def get
+      client.get_pixel(graph_id: graph_id, date: date)
+    end
+
+    # Update the quantity already registered as a "Pixel".
+    #
+    # @param quantity [Integer,Float]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").pixel(Date.new(2018, 9, 15)).update(quantity: 7)
+    def update(quantity:)
+      client.update_pixel(graph_id: graph_id, date: date, quantity: quantity)
+    end
+
+    # Delete the registered "Pixel".
+    #
+    # @return [Hashie::Mash]
+    #
+    # @raise [Pixela::PixelaError] API is failed
+    #
+    # @see https://pixe.la/#api-pixel
+    #
+    # @example
+    #   client.graph("test-graph").pixel(Date.new(2018, 9, 15)).delete
+    def delete
+      client.delete_pixel(graph_id: graph_id, date: date)
+    end
+  end
+end

data/lib/pixela/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixela
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -227,6 +227,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".env.example"
 - ".gitignore"
 - ".rspec"
@@ -245,6 +246,8 @@ files:
 - lib/pixela/client/pixel_methods.rb
 - lib/pixela/client/user_methods.rb
 - lib/pixela/configuration.rb
+- lib/pixela/graph.rb
+- lib/pixela/pixel.rb
 - lib/pixela/version.rb
 - pixela.gemspec
 homepage: https://github.com/sue445/pixela