vkponchik 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d9121e737cf5462f86b09401971c5ce866f7b00d4676ca335d486a230089eb6
+  data.tar.gz: 61e95e6a190805710fe86737ba8f466a89b3ec5b2591d124d445a585d9115124
+SHA512:
+  metadata.gz: 3cc15cfc9615f63d76d368d7599ffa42cd1ed9498fd2b842225f90d2329b637d1cd4f56bcea0cc1cb4dc95c5b6e232aee2058cdd099c3f8a74a8cbac3ab68aca
+  data.tar.gz: 7ecb79a72fd4449b41c86fac87c25d337c3e41efa43aff7a6cff111419372f08b3e1e4fdda133fc146dd8e50b596e46e377b184406996ba1d5eb2dc6d7c4ddb5

data/.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    environment: test
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the rspec task
+      env:
+        VKPONCHIK_GROUP: ${{ secrets.VKPONCHIK_GROUP }}
+        VKPONCHIK_TOKEN: ${{ secrets.VKPONCHIK_TOKEN }}
+      run: |
+        gem install bundler -v 2.2.4
+        bundle install
+        bundle exec rake spec
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the rubocop task
+      run: |
+        gem install bundler -v 2.2.4
+        bundle install
+        bundle exec rake rubocop
+

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Dotenv for testing
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vkponchik.gemspec
+gemspec
+
+gem 'rake'
+
+gem 'rspec'
+
+gem 'rubocop'
+
+gem 'rubocop-rake', require: false
+
+gem 'rubocop-rspec', require: false
+
+gem 'dotenv'
+
+gem 'simplecov', require: false

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    vkponchik (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    docile (1.3.4)
+    dotenv (2.7.6)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  rake
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+  vkponchik!
+
+BUNDLED WITH
+   2.2.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vladislav Kuznecov
+
+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/README.md

@@ -0,0 +1,33 @@
+# Vkponchik
+
+Really small and simple gem for interacting with vkdonuts.ru API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vkponchik'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vkponchik
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fizvlad/vkponchik-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'vkponchik'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vkponchik.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'vkponchik/version'
+require_relative 'vkponchik/client'
+require_relative 'vkponchik/response'
+
+# Vkponhik library namespace
+module Vkponchik
+  class Error < StandardError; end
+end

data/lib/vkponchik/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Vkponchik
+  # API client class
+  class Client
+    API_VERSION = 1
+    API_BASE = 'https://api.vkdonuts.ru'
+    API_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+    API_METHODS = [
+      'donates/get', 'donates/change-status', 'donates/answer', 'donates/change-reward-status',
+      'campaigns/get', 'campaigns/get-active', 'campaigns/get-rewards', 'campaigns/change',
+      'campaigns/change-reward', 'payments/get', 'payments/create', 'balance'
+    ].freeze
+
+    # Initialize new client
+    # @param group [Integer] group ID
+    # @param token [String] group API token
+    def initialize(group, token)
+      @group = group
+      @token = token
+    end
+
+    # Send POST request to API server
+    # @param method [String] see {API_METHODS} array
+    # @param params [Hash] parameters to pass in POST request
+    # @return [Hash]
+    def request(method, **params)
+      validate_request_options(method, **params)
+
+      params[:v] = API_VERSION
+      params[:group] = @group
+      params[:token] = @token
+
+      uri = URI("#{API_BASE}/#{method}")
+      re = Net::HTTP.post(uri, params.to_json, API_HEADERS)
+
+      Response.new(JSON.parse(re.body))
+    rescue StandardError
+      raise Vkponchik::Error, 'Request failure'
+    end
+
+    private
+
+    def validate_request_options(method, **_params)
+      raise Vkponchik::Error, 'Invalid request method' unless API_METHODS.include?(method)
+    end
+  end
+end

data/lib/vkponchik/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Vkponchik
+  # API response
+  class Response
+    # @param hash [Hash]
+    def initialize(hash)
+      @hash = hash
+    end
+
+    # @return [Boolean]
+    def error?
+      !@hash['success']
+    end
+
+    # @return [Boolean]
+    def success?
+      !error?
+    end
+
+    # @return [String?]
+    def error_full_message
+      return unless error?
+
+      "#{@hash['error']}: #{@hash['msg']}"
+    end
+
+    # @return [Object?]
+    def [](arg)
+      @hash[arg.to_s]
+    end
+  end
+end

data/lib/vkponchik/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vkponchik
+  VERSION = '1.0.0'
+end

data/vkponchik.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/vkponchik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vkponchik'
+  spec.version       = Vkponchik::VERSION
+  spec.authors       = ['Vladislav Kuznecov']
+  spec.email         = ['fizvlad@mail.ru']
+
+  spec.summary       = 'API client for VK Ponchik donations service.'
+  spec.homepage      = 'https://github.com/fizvlad/vkponchik-rb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fizvlad/vkponchik-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/fizvlad/vkponchik-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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: vkponchik
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladislav Kuznecov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- fizvlad@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vkponchik.rb
+- lib/vkponchik/client.rb
+- lib/vkponchik/response.rb
+- lib/vkponchik/version.rb
+- vkponchik.gemspec
+homepage: https://github.com/fizvlad/vkponchik-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fizvlad/vkponchik-rb
+  source_code_uri: https://github.com/fizvlad/vkponchik-rb
+  changelog_uri: https://github.com/fizvlad/vkponchik-rb/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key: 
+specification_version: 4
+summary: API client for VK Ponchik donations service.
+test_files: []