prtscr 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27e3cdbbb0a6be6010d11ce5e672132992ded8a6
-  data.tar.gz: 65d2a06c2bce814764adfb5844341217f059825e
+SHA256:
+  metadata.gz: fd71d32117b01be234eeefb0c6b9b431cbcc27d9fd018653d53e29f32a2b24cb
+  data.tar.gz: e5562258a66c4b6b3f306acb98f6c1d24da45654965436b867aae80511686a99
 SHA512:
-  metadata.gz: 3104a2cb6cc30fe9e7347c06b660791eb939c685578875115efe1d092ca18e8eba045fade68949bf57e4400a1ff9ed27dd9e4745ae12c787510e4ab151d7c7b4
-  data.tar.gz: ec53bdae56992836b67e2c08c322e3718fc802e50e6fd8b3a05fe269f3aa7954c6b948d2dee679853a7ede65ca7d69d2320b52e2725114e93957b451c4d76175
+  metadata.gz: 0b963b49b70cd584acb469af715f5b084a4d4b04a2d03b3c10d3385a1be112a3076533d2767b5e881c6a6d5e458b465bf6e77a564b199cb97005a256ed5c2425
+  data.tar.gz: abd3af24c81ed508b58a9a3830d9e9121c7dbefeb9e7daa6ae4188a34a0c6242f0f61d69b9b629c1177678a6449d970012247db1b7394c8e06bdbe9ec1808385

data/.gitignore

@@ -1,9 +1,11 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+require: rubocop-rspec
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']

data/.travis.yml

@@ -1,5 +1,6 @@
-sudo: false
+---
 language: ruby
+cache: bundler
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.13.7
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,13 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in prtscr.gemspec
 gemspec
+
+gem 'rake', '~> 12.0', require: false
+
+group :development, :test do
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    prtscr (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.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)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  prtscr!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 vickodin
+Copyright (c) 2021 vickodin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,8 @@
-# Prtscr.ru API gem
+# Prtscr
 
-This gem is a lib for [PrtScr.ru](https://prtscr.ru/) API (website screenshot).
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prtscr`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -12,7 +14,7 @@ gem 'prtscr'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,49 +22,23 @@ Or install it yourself as:
 
 ## Usage
 
-run the next line of code:
-
-```ruby
-Prtscr.get(url: 'https://google.com', width: 1280, height: 1024, scale: 250, key: 'YOUR_KEY_HERE', secret: 'YOUR_SECRET_HERE', format: 'jpg')
-```
-
-And get something like:
-
-```
-https://prtscr.ru/v2/1280x1024/250/1484317141/AIQACodQ/be8d94e167d4e0e9c6d8e106582f0894/aHR0cHM6Ly9nb29nbGUuY29t.jpg
-```
-
-Having previous line, you can use html img tag:
-
-![Google website screenshot](https://prtscr.ru/v2/1280x1024/250/1484317141/AIQACodQ/be8d94e167d4e0e9c6d8e106582f0894/aHR0cHM6Ly9nb29nbGUuY29t.jpg)
-
-### Available options
-
-**url**: URL Address
-
-**width**: Browser width, px
-
-**height**: Browser height, px
-
-**scale**: Screenshot scale for width, px
-
-**key**: Your Key
-
-**secret**: Your Secret
-
-**format**: Screenshot extension
-
-**key** and **secret** options you can obtain at [PrtScr.ru](https://prtscr.ru/)
+TODO: Write usage instructions here
 
 ## 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 tags, 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/vickodin/prtscr.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prtscr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/prtscr/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Prtscr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/prtscr/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :default => :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'prtscr'
+require "bundler/setup"
+require "prtscr"
 
 # 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.
@@ -10,5 +10,5 @@ require 'prtscr'
 # require "pry"
 # Pry.start
 
-require 'irb'
-IRB.start
+require "irb"
+IRB.start(__FILE__)

data/lib/prtscr.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
+
 require 'prtscr/version'
+require 'digest'
 require 'base64'
 
-# Main Module
+require 'prtscr/v1'
+require 'prtscr/v2'
+require 'prtscr/v3'
+
+# Main module
 module Prtscr
-  def self.get(data)
+  extend Prtscr::V1
+  extend Prtscr::V2
+  extend Prtscr::V3
+
+  class Error < StandardError; end
+
+  def self.get(params)
     # TODO: Move default values to initializer
-    d = {
-      version: 'v2',
-      width: '1280',
-      height: '1024',
-      scale: '500',
-      format: 'jpg',
-      timestamp: Time.now.to_i,
-      scheme: 'https:/',
-      host: 'prtscr.ru'
-    }.merge(data)
+    data = {
+      version: 'v3', width: '1280', height: '1024', scale: '500',
+      format: 'jpg', timestamp: Time.now.to_i, scheme: 'https:/', host: 'prtscr.ru'
+    }.merge(params)
 
-    if d[:version] == 'v1'
-      d[:url] = URI.encode_www_form_component(d[:url])
-      d[:sign] = Digest::MD5.hexdigest([d[:width], d[:height], d[:scale], d[:format], d[:timestamp], d[:key], d[:url], d[:secret]].join(''))
-      d[:size] = [d[:width], d[:height]].join('x')
-      return [d[:scheme], d[:host], d[:version], d[:size], d[:scale], d[:format], d[:timestamp], d[:key], d[:sign], d[:url]].join('/')
-    elsif d[:version] == 'v2'
-      d[:url] = Base64.urlsafe_encode64(d[:url])
-      d[:sign] = Digest::MD5.hexdigest([d[:width], d[:height], d[:scale], d[:timestamp], d[:key], d[:url], d[:format], d[:secret]].join(''))
-      d[:size] = [d[:width], d[:height]].join('x')
-      return [[d[:scheme], d[:host], d[:version], d[:size], d[:scale], d[:timestamp], d[:key], d[:sign], d[:url]].join('/'), d[:format]].join('.')
+    case data[:version]
+    when 'v1' then v1(data)
+    when 'v2' then v2(data)
+    when 'v3' then v3(data)
     end
   end
 end

data/lib/prtscr/v1.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Prtscr
+  # Version 1:
+  module V1
+    def v1(data)
+      [
+        data[:scheme], data[:host],
+        data[:version], v1_size(data), data[:scale], data[:format], data[:timestamp], data[:key],
+        v1_sign(data), v1_url(data[:url])
+      ].join('/')
+    end
+
+    def v1_sign(data)
+      ::Digest::MD5.hexdigest(
+        [
+          data[:width], data[:height], data[:scale], data[:format], data[:timestamp],
+          data[:key], v1_url(data[:url]), data[:secret]
+        ].join('')
+      )
+    end
+
+    def v1_size(data)
+      [data[:width], data[:height]].join('x')
+    end
+
+    def v1_url(url)
+      ::URI.encode_www_form_component(url)
+    end
+  end
+end

data/lib/prtscr/v2.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Prtscr
+  # Version 2:
+  module V2
+    def v2(data)
+      [
+        [
+          data[:scheme], data[:host], data[:version], v2_size(data), data[:scale],
+          data[:timestamp], data[:key], v2_sign(data), v2_url(data[:url])
+        ].join('/'), data[:format]
+      ].join('.')
+    end
+
+    def v2_sign(data)
+      ::Digest::MD5.hexdigest(
+        [
+          data[:width], data[:height], data[:scale], data[:timestamp], data[:key],
+          v2_url(data[:url]), data[:format], data[:secret]
+        ].join('')
+      )
+    end
+
+    def v2_size(data)
+      [data[:width], data[:height]].join('x')
+    end
+
+    def v2_url(url)
+      Base64.urlsafe_encode64(url)
+    end
+  end
+end

data/lib/prtscr/v3.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Prtscr
+  # Version 2:
+  module V3
+    def v3(data)
+      "https://prtscr.ru/v3/screenshot.#{data[:format]}?#{v3_query(data)}"
+    end
+
+    def v3_sign(data)
+      ::Digest::MD5.hexdigest(
+        [
+          data[:url], data[:format], data[:key], data[:width],
+          data[:height], data[:scale], data[:secret]
+        ].map(&:to_s).join
+      )
+    end
+
+    def v3_query(data)
+      ::URI.encode_www_form(
+        {
+          url: data[:url],
+          key: data[:key],
+          sign: v3_sign(data),
+          width: data[:width],
+          height: data[:height],
+          scale: data[:scale]
+        }.compact
+      )
+    end
+  end
+end

data/lib/prtscr/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prtscr
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.3.0'
 end

data/prtscr.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'prtscr/version'
+# frozen_string_literal: true
+
+require_relative 'lib/prtscr/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'prtscr'
@@ -10,28 +9,23 @@ Gem::Specification.new do |spec|
   spec.email         = ['vick.orel@gmail.com']
 
   spec.summary       = 'PrtScr.ru API gem'
-  spec.description   = 'Website screenshot API gem for http://prtscr.ru'
+  spec.description   = 'Website screenshot API gem for https://prtscr.ru'
   spec.homepage      = 'https://github.com/vickodin/prtscr'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #  raise "RubyGems 2.0 or newer is required to protect against " \
-  #    "public gem pushes."
-  # end
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/vickodin/prtscr'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  # 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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.46.0'
 end

metadata

@@ -1,72 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: prtscr
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - vickodin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !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
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.46.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.46.0
-description: Website screenshot API gem for http://prtscr.ru
+date: 2021-01-11 00:00:00.000000000 Z
+dependencies: []
+description: Website screenshot API gem for https://prtscr.ru
 email:
 - vick.orel@gmail.com
 executables: []
@@ -75,21 +19,28 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/prtscr.rb
+- lib/prtscr/v1.rb
+- lib/prtscr/v2.rb
+- lib/prtscr/v3.rb
 - lib/prtscr/version.rb
 - prtscr.gemspec
 homepage: https://github.com/vickodin/prtscr
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/vickodin/prtscr
+  source_code_uri: https://github.com/vickodin/prtscr
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -98,15 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: PrtScr.ru API gem