random_org_http_api 0.0.3.1 → 0.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87cf6a543500185e6d40cf14dca165293ab0a10a
-  data.tar.gz: 20ed9d531372a7d75c311091b441f3bd77c4d021
+  metadata.gz: a71dd4b3a01bcce935056f7297cdd5169a9fadfb
+  data.tar.gz: f0fa6046ae5de636309b22bc4cbdaadc3fc0b41c
 SHA512:
-  metadata.gz: 5ee6fccefdb7e4d2ad4bfe3bb51f971614321323876100ca50d81af235935fd9d5bde4131856e2c06d61f5dd9d1cf23766ebebf31d0a5fcf33f33315d80d04ab
-  data.tar.gz: 36aafa91b88db009501db467309e9fd148660bd83244d5f7109f18c7ade44990ab6ba3741c98dbaf8add1be3387bbdad76c4527095906cb7a5c8fd6d86e9fc77
+  metadata.gz: b01e9036de8feb91009704e5ff888b158b767bebd20c019d0fb8a887c232229967f265d1b4942bbaef638bd1c12a337f189146e46d3697eda114d5d4e75c429b
+  data.tar.gz: 1b3fb96d3e30229705f7968be11564623884d6fb42ccc490062adf5e986a81ba91c77a39631a4336ca96f5efd53b2a9d29b59d5cab7826934b9bb1bebdd38238

data/Gemfile

@@ -1,9 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in random_org_http_api.gemspec
 gemspec
 
 group :test do
-  gem 'simplecov', :require => false
+  gem 'simplecov', require: false
   gem 'coveralls', require: false
-end
+  gem 'rubocop', require: false
+end

data/Rakefile

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

data/lib/random_org_http_api/configuration.rb

@@ -1,30 +1,32 @@
 module RandomOrgHttpApi
   module Configuration
-    DOMAIN = 'https://www.random.org'
-    DEFAULT_QUERY_PARAMS = {
-        format: 'plain',
-        base: '10',
-        rnd: 'new',
-        col: '1',
-        min: '1',
-        digits: 'on',
-        loweralpha: 'on',
-        upperalpha: 'on',
-        unique: 'on'
-    }
-
-    # Query templates
-    # Integer
-    INTEGER_QUERY_KEYS = [:num, :min, :max, :col, :base, :format, :rnd]
-    INTEGER_QUERY_TEMPLATE = "integers/?num=%{num}&min=%{min}&max=%{max}&col=%{col}&base=%{base}&format=%{format}&rnd=%{rnd}"
+    BASE_URI = 'https://www.random.org'.freeze
 
-    # String
-    STRING_QUERY_KEYS = [:num, :len, :digits, :upperalpha, :loweralpha, :unique, :format, :rnd]
-    STRING_QUERY_TEMPLATE = "strings/?num=%{num}&len=%{len}&digits=%{digits}&upperalpha=%{upperalpha}&loweralpha=%{loweralpha}&unique=%{unique}&format=%{format}&rnd=%{rnd}"
-
-    # Sequence
-    SEQUENCE_QUERY_KEYS = [:min, :max, :col, :format, :rnd]
-    SEQUENCE_QUERY_TEMPLATE = "sequences/?min=%{min}&max=%{max}&col=%{col}&format=%{format}&rnd=%{rnd}"
+    DEFAULT_QUERY_PARAMS = {
+      format: 'plain',
+      base: '10',
+      rnd: 'new',
+      col: '1',
+      min: '1',
+      digits: 'on',
+      loweralpha: 'on',
+      upperalpha: 'on',
+      unique: 'on'
+    }.freeze
 
+    QUERY_TEMPLATE = {
+      integer: {
+        path: '/integers',
+        query_keys: [:num, :min, :max, :col, :base, :format, :rnd]
+      },
+      string: {
+        path: '/strings',
+        query_keys: [:num, :len, :digits, :upperalpha, :loweralpha, :unique, :format, :rnd]
+      },
+      sequence: {
+        path: '/sequences',
+        query_keys: [:min, :max, :col, :format, :rnd]
+      }
+    }.freeze
   end
-end
+end

data/lib/random_org_http_api/error.rb

@@ -0,0 +1,12 @@
+module RandomOrgHttpApi
+  module Error
+    class QuotaError < StandardError
+      def message
+        'Quota is over. Please try again later.'
+      end
+    end
+  end
+end
+
+
+

data/lib/random_org_http_api/generator.rb

@@ -1,76 +1,73 @@
+require 'open-uri'
+
 module RandomOrgHttpApi
   class Generator
-    require 'net/http'
     include RandomOrgHttpApi::Configuration
-
-    def generate_integers(params = {})
-      integers_query = query('integer', params)
-      request(DOMAIN, integers_query)
+    include RandomOrgHttpApi::Error
+    
+    def generate_integers(params)
+      generate(:integer, params)
     end
 
-    def generate_strings(params = {})
-      strings_query = query('string', params)
-      request(DOMAIN, strings_query)
+    def generate_strings(params)
+      generate(:string, params)
     end
 
-    def generate_sequence(params = {})
-      sequence_query = query('sequence', params)
-      request(DOMAIN, sequence_query)
+    def generate_sequence(params)
+      generate(:sequence, params)
     end
 
-    # Quota Checker
     def quota
-      quota_query = "quota/?ip=#{ip}&format=plain"
-      request(DOMAIN, quota_query).first.to_i
+      params = { path: '/quota', params: { ip: ip, format: 'plain' } }
+      api_request(params).first.to_i
+    end
+
+    def ip
+      request(uri: 'http://whatismyip.akamai.com').strip
     end
 
     private
 
-    # Метод запроса на сайт random.org
-    def request(domain, query)
-      # Создаем запрос
-      uri = URI.join(domain, query)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      res = http.get(uri.request_uri)
-      # Если все хорошо, то возвращаем форматированный ответ,
-      # если нет, то показываем ответ ошибки сервера.
-      res.is_a?(Net::HTTPSuccess) ? res.body.split : res.body.strip
+    def generate(type, params = {})
+      params = query(type, params)
+      api_request(params)
     end
 
-    # Метод для генерации запроса
-    def query(object_type, params)
-      # Совмещаем параметры по умолчанию с параметами, который передал пользователь
-      all_params = DEFAULT_QUERY_PARAMS.merge(params)
-      # В зависимости от типа объекта, который нужно сгенерировать, оставляем только нужные для него параметры.
-      case object_type
-        when 'integer' then
-          right_params = permit_params(all_params, INTEGER_QUERY_KEYS)
-          insert_params(right_params, INTEGER_QUERY_TEMPLATE)
-        when 'string' then
-          right_params = permit_params(all_params, STRING_QUERY_KEYS)
-          insert_params(right_params, STRING_QUERY_TEMPLATE)
-        when 'sequence' then
-          right_params = permit_params(all_params, SEQUENCE_QUERY_KEYS)
-          insert_params(right_params, SEQUENCE_QUERY_TEMPLATE)
-      end
+    def api_request(hash)
+      request(uri: URI(BASE_URI), path: hash[:path], query: hash[:params]).split
     end
 
-    # Метод оставляющий только нужные параметры.
-    def permit_params(params, required_keys)
-      params.select { |k| required_keys.include?(k) }
-    end
 
-    # Метод подстановки параметров в темплейт.
-    # Параметры должны передаваться в хеше
-    def insert_params(params, template)
-      template % params
+    def request(params)
+      uri = URI params[:uri]
+      uri.path = params[:path] if params[:path]
+      uri.query = URI.encode_www_form(params[:query]) if params[:query]
+
+      exception_cb = Proc.new do |exception|
+        puts exception
+      end
+
+      Retryable.retryable(tries: 3, on: OpenURI::HTTPError, exception_cb: exception_cb) do |retries, exception|
+        if retries > 1
+          raise QuotaError if quota == 0
+        end
+        open(uri).read
+      end
     end
 
-    def ip
-      uri = URI('http://whatismyip.akamai.com')
-      Net::HTTP.get(uri)
+
+    def query(generator_type, params)
+      all_params = DEFAULT_QUERY_PARAMS.merge(params)
+      template = QUERY_TEMPLATE[generator_type]
+
+      {
+        path: template[:path],
+        params: permit_params(all_params, template[:query_keys])
+      }
     end
 
+    def permit_params(params, required_keys)
+      params.select { |k| required_keys.include?(k) }
+    end
   end
-end
+end

data/lib/random_org_http_api/version.rb

@@ -1,3 +1,3 @@
 module RandomOrgHttpApi
-  VERSION = "0.0.3.1"
+  VERSION = '0.1.alpha'.freeze
 end

data/lib/random_org_http_api.rb

@@ -1,5 +1,6 @@
-require "random_org_http_api/version"
-require "random_org_http_api/configuration"
-require "random_org_http_api/generator"
+require 'random_org_http_api/version'
+require 'random_org_http_api/error'
+require 'random_org_http_api/configuration'
+require 'random_org_http_api/generator'
 
-module RandomOrgHttpApi;end
+module RandomOrgHttpApi; end

data/random_org_http_api.gemspec

@@ -4,21 +4,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'random_org_http_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "random_org_http_api"
-  spec.version       = RandomOrgHttpApi::VERSION
-  spec.authors       = ["Temur Fatkulin"]
-  spec.email         = ["temur.fatkulin@gmail.com"]
-  spec.summary       = %q{Realization of old HTTP API provided by the random.org service}
-  spec.description   = %q{At present realized generation for numbers, strings and sequences}
-  spec.homepage      = "https://github.com/istickz/random_org_http_api"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.name = 'random_org_http_api'
+  spec.version = RandomOrgHttpApi::VERSION
+  spec.authors = ['Temur Fatkulin']
+  spec.email = ['temur.fatkulin@gmail.com']
+  spec.summary = 'Realization of old HTTP API provided by the random.org service'
+  spec.description = 'At present realized generation for numbers, strings and sequences'
+  spec.homepage = 'https://github.com/istickz/random_org_http_api'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_dependency 'retryable'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/spec/random_org_http_api/generator_spec.rb

@@ -1,63 +1,77 @@
-require "spec_helper"
+require 'spec_helper'
 describe RandomOrgHttpApi::Generator do
 
   before(:all) do
     @generator = RandomOrgHttpApi::Generator.new
   end
 
-  describe '#insert_params' do
-    it 'should do insert params in string' do
-      params = {name: 'World'}
-      string = 'Hello %{name}'
-      expect(@generator.send(:insert_params, params, string)).to eq('Hello World')
-    end
-  end
-
   describe '#permit_params' do
     it 'should do permit only required params' do
-      params = {a: 'A', b: 'B', c: 'C'}
+      input_params = { a: 'A', b: 'B', c: 'C' }
       required_keys = [:a, :b]
-      expect(@generator.send(:permit_params, params, required_keys)).to eq({a: 'A', b: 'B'})
+      output_params = { a: 'A', b: 'B' }
+      expect(@generator.send(:permit_params, input_params, required_keys)).to eq(output_params)
     end
   end
 
   describe '#query' do
-    it 'should do generate right query for integer' do
-      object_type = 'integer'
-      params = {num: 4, max: 100}
-      right_query = 'integers/?num=4&min=1&max=100&col=1&base=10&format=plain&rnd=new'
-      expect(@generator.send(:query, object_type, params)).to eq(right_query)
-    end
+    it 'should do generate right params for integer' do
+      generator_type = :integer
+      input_params = { num: 4, max: 100 }
+      output_params =
+        {
+          path: '/integers',
+          params: {
+            format: 'plain',
+            base: '10',
+            rnd: 'new',
+            col: '1',
+            min: '1',
+            num: 4,
+            max: 100
+          }
+        }
 
-    it 'should do generate right query for string' do
-      object_type = 'string'
-      params = {min: 1, max: 10, num: 3, len: 5}
-      right_query = 'strings/?num=3&len=5&digits=on&upperalpha=on&loweralpha=on&unique=on&format=plain&rnd=new'
-      expect(@generator.send(:query, object_type, params)).to eq(right_query)
+      expect(@generator.send(:query, generator_type, input_params)).to eq(output_params)
     end
 
-    it 'should do generate right query for sequence' do
-      object_type = 'sequence'
-      params = {num: 5, len: 10, max: 10}
-      right_query = 'sequences/?min=1&max=10&col=1&format=plain&rnd=new'
-      expect(@generator.send(:query, object_type, params)).to eq(right_query)
-    end
-  end
+    it 'should do generate right params for string' do
+      generator_type = :string
+      input_params = { min: 1, max: 10, num: 3, len: 5 }
 
-  describe '#request' do
-    domain = 'https://www.random.org'
+      output_params = {
+        path: '/strings',
+        params: {
+          format: 'plain',
+          rnd: 'new',
+          digits: 'on',
+          loweralpha: 'on',
+          upperalpha: 'on',
+          unique: 'on',
+          num: 3,
+          len: 5
+        }
+      }
 
-    it 'should do return string with error message if request have bad response' do
-      bad_query = 'strings/?num=HelloWorld&len=5&digits=on&upperalpha=on&loweralpha=on&unique=on&format=plain&rnd=new'
-      expect(@generator.send(:request, domain, bad_query).class).to eq(String)
+      expect(@generator.send(:query, generator_type, input_params)).to eq(output_params)
     end
 
-    it 'should do return array if request have good response' do
-      if @generator.quota > 0
-        good_query = 'strings/?num=3&len=5&digits=on&upperalpha=on&loweralpha=on&unique=on&format=plain&rnd=new'
-        expect(@generator.send(:request, domain, good_query).class).to eq(Array)
-      end
+    it 'should do generate right params for sequence' do
+      generator_type = :sequence
+      input_params = { num: 5, len: 10, max: 10 }
+
+      output_params = {
+        path: '/sequences',
+        params: {
+          format: 'plain',
+          rnd: 'new',
+          col: '1',
+          min: '1',
+          max: 10
+        }
+      }
+
+      expect(@generator.send(:query, generator_type, input_params)).to eq(output_params)
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -2,9 +2,9 @@ require 'simplecov'
 require 'coveralls'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
 ]
 SimpleCov.start
 
-require File.expand_path("../../lib/random_org_http_api", __FILE__)
+require File.expand_path('../../lib/random_org_http_api', __FILE__)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: random_org_http_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3.1
+  version: 0.1.alpha
 platform: ruby
 authors:
 - Temur Fatkulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +83,7 @@ files:
 - Rakefile
 - lib/random_org_http_api.rb
 - lib/random_org_http_api/configuration.rb
+- lib/random_org_http_api/error.rb
 - lib/random_org_http_api/generator.rb
 - lib/random_org_http_api/version.rb
 - random_org_http_api.gemspec
@@ -89,12 +104,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Realization of old HTTP API provided by the random.org service