vkdonate 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3957050d94309e6927a44362cca62f4fb15627ef4a9807fc8b0d5f4c53e1cd
-  data.tar.gz: a29f2e7e9fbe8538c6e642d91892ec979ef9a4d1f385c1489aafaddf4d8c6e54
+  metadata.gz: e7d590e413133110ae7c498dbcb5babc8787e9e02714faece8749fe656b6b9a6
+  data.tar.gz: 37d6cba556d5b89adf9c3350a6d9ed1fe60913adb43e3a548348268be6241055
 SHA512:
-  metadata.gz: bb0b354c720750fea4f6a1ac6b194c62b933f155b7dce8dc8db7aaeab01d62826f84873ef9298cd5d139a507e9a17abf06a5b7ae5dc9ddc70f073be000e8ccbb
-  data.tar.gz: 5e2465bbc2eebf81e8928e0b2d82fb44fd5f01ecc0e0b3852817d8c1f08bf3df8caa8b464d84ef04e555851013b1f7cc950d1cb84ee30c9a7c2218a282ef2787
+  metadata.gz: e5cbdf8761845b8f913a1cfdad612984c25a807f4c7963ed518b061b299e714ffea0d8c580d70042b213bcc581d70d0b1a729ce55c60bce3498bd9b7ffc3121f
+  data.tar.gz: b93c736343ce86fecb6062ddc1c631f061f396c9937cbcd4c5d148258c56bfaa2ad5599d4bcd52259ee6a1da026fc9d0709add3a4bfa48d6c5c160ea12347f37

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vkdonate.gemspec
+gemspec
+
+gem "json", "~> 2.2"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    vkdonate (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (2.2.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  json (~> 2.2)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  vkdonate!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kuznecov Vladislav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vkdonate"
+
+require "irb"
+IRB.start(__FILE__)

data/lib/vkdonate/version.rb

@@ -0,0 +1,7 @@
+module Vkdonate
+
+  ##
+  # Gem version.
+  VERSION = "1.0.1"
+
+end

data/lib/vkdonate.rb

@@ -0,0 +1,216 @@
+require "vkdonate/version"
+
+require "net/http"
+require "json"
+require "date"
+
+##
+# Main module.
+module Vkdonate
+
+  ##
+  # URI for requests.
+  REQUEST_URI = URI("https://api.vkdonate.ru")
+
+  ##
+  # Array of available actions.
+  ACTIONS = [:donates]
+
+  ##
+  # Array of available sort-by.
+  SORT = [:date, :sum]
+
+  ##
+  # Array of available order-by.
+  ORDER = [:asc, :desc]
+
+  ##
+  # Time offset of API server.
+  TIME_OFFSET = "UTC+3"
+
+  ##
+  # @!macro [new] request_option
+  #    @option options [Integer] count (10) amount of donates (up to 50).
+  #    @option options [Integer] offset (0) donates offset.
+  #    @option options [Symbol] sort (:date) sort by.
+  #    @option options [Symbol] order (:desc) order by.
+  #    @see Vkdonate::SORT
+  #    @see Vkdonate::ORDER
+  #
+  # @!macro [new] request_return
+  #    @return [Array]
+  #
+  # @!macro [new] request
+  #    Simple POST request to API.
+  #    @param action [Symbol]
+  #    @param options [Hash]
+  #    @!macro request_option
+  #    @see Vkdonate::ACTIONS
+  #    @!macro request_return
+  #
+  # @!macro [new] donates
+  #    POST request for +donates+ action.
+  #    @param options [Hash]
+  #    @!macro request_option
+  #    @see Vkdonate::ACTIONS
+  #    @!macro request_return
+
+  ##
+  # @param api_key [String]
+  # @!macro request
+  def self.request(api_key, action, options = {})
+    raise "Unknown action" unless ACTIONS.include? action
+
+    count = options[:count] || 10
+    offset = options[:offset] || 0
+    sort = options[:sort] || :date
+    order = options[:order] || :desc
+
+    raise "Count is out of range" unless count >= 1 && count <= 50
+    raise "Offset is out of range" unless offset >= 0
+    raise "Unknown sorting" unless SORT.include? sort
+    raise "Unknown ordering" unless ORDER.include? order
+
+    res = Net::HTTP.post_form(REQUEST_URI,
+      key: api_key.to_s,
+      action: action.to_s,
+      count: count.to_i,
+      offset: offset.to_i,
+      sort: sort.to_s,
+      order: order.to_s
+    )
+
+    json = JSON.parse res.body
+
+    if json["success"]
+      json["donates"].map { |e| Donate.from_json(e) }
+    else
+      raise json["text"]
+    end
+  end
+
+  ##
+  # @param api_key [String]
+  # @!macro donates
+  def self.donates(api_key, options = {})
+    request(api_key, :donates, options)
+  end
+
+  ##
+  # Single donation
+  class Donate
+
+    ##
+    # @return [Integer] Unique payment ID.
+    attr_reader :id
+
+    ##
+    # @return [Integer] Donator VK ID.
+    attr_reader :uid
+
+    ##
+    # @return [DateTime] Date and time of donation.
+    attr_reader :date
+
+    ##
+    # @return [Integer] Size of donation.
+    attr_reader :sum
+
+    ##
+    # @return [String, nil] User message or +nil+ if empty.
+    attr_reader :msg
+    alias_method :message, :msg
+
+    ##
+    # @return [Boolean] Whether donation is anonymous.
+    attr_reader :anon
+    alias_method :anon?, :anon
+
+    ##
+    # @return [Boolean] Whether donate is visible in group.
+    attr_reader :visible
+    alias_method :visible?, :visible
+
+    ##
+    # @return [String] Human readable information.
+    def to_s
+      "Donation ##{id} by @#{uid} for #{sum}RUR (at #{date})"
+    end
+
+    ##
+    # Save data about donation.
+    #
+    # @param options [Hash]
+    #
+    # @option options [Integer] id
+    # @option options [Integer] uid
+    # @option options [DateTime] date
+    # @option options [Integer] sum
+    # @option options [String, nil] msg
+    # @option options [Boolean] anon
+    # @option options [Boolean] visible
+    def initialize(options)
+      @id = options[:id].to_i
+
+      @uid = options[:uid].to_i
+
+      @date = options[:date]
+      raise unless DateTime === @date
+
+      @sum = options[:sum].to_i
+
+      @msg = options[:msg].to_s
+      @msg = nil if @msg.empty?
+
+      @anon = !!options[:anon]
+
+      @visible = !!options[:visible]
+    end
+
+    ##
+    # Parse from JSON hash.
+    #
+    # @param hash [Hash] parsed JSON hash.
+    #
+    # @return [Donate]
+    def self.from_json(hash)
+      self.new(
+        id: hash["id"].to_i,
+        uid: hash["uid"].to_i,
+        date: DateTime.parse(hash["date"] + " #{TIME_OFFSET}"),
+        sum: hash["sum"].to_i,
+        msg: hash["msg"].empty? ? nil : hash["msg"],
+        anon: !hash["anon"].to_i.zero?,
+        visible: !hash["visible"].to_i.zero?
+      )
+    end
+
+  end
+
+  ##
+  # Client which saves API key.
+  class Client
+
+    ##
+    # New client to work with API.
+    #
+    # @param api_key [String]
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    ##
+    # @!macro request
+    def request(action, options = {})
+      Vkdonate.request(@api_key, action, options)
+    end
+
+    ##
+    # @!macro donates
+    def donates(options = {})
+      Vkdonate.donates(@api_key, options)
+    end
+
+  end
+
+end

data/vkdonate.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vkdonate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vkdonate"
+  spec.version       = Vkdonate::VERSION
+  spec.authors       = ["Fizvlad"]
+  spec.email         = ["fizvlad@mail.ru"]
+
+  spec.summary       = "This is small non-official gem which provides interface to interact with vkdonate.ru API"
+  spec.homepage      = "https://github.com/fizvlad/vkdonate-rb"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fizvlad/vkdonate-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/fizvlad/vkdonate-rb/releases"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vkdonate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Fizvlad
@@ -59,7 +59,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
+- Rakefile
+- bin/console
+- lib/vkdonate.rb
+- lib/vkdonate/version.rb
+- vkdonate.gemspec
 homepage: https://github.com/fizvlad/vkdonate-rb
 licenses:
 - MIT