random_org_http_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbea6bdd5b9f7d7494b0d5f01ae6c2d96ea71148
-  data.tar.gz: a0ab30808e48caa6b4abbd9fed281a271014da6d
+  metadata.gz: 339dec176cb7f910f4a76ef4d4ee7c9045290303
+  data.tar.gz: 414d5c5d5befa1894beeb772274977758798cea8
 SHA512:
-  metadata.gz: 0b988426d9015db7afe1a2ebd7c3a88992a3bcd259a54450a7046bffdde10211ec211d2c71bba120d8ba07c1aab7ee3d7e56578a39453fea801b942921866329
-  data.tar.gz: 2dc4c7bce8019a3b753206333f7960019257dfb8d8a29b01df22aeaecb4cb3f03c2a27e8edadbc7eaaf587befceee6c70ef81428c0f5f13aadd6f70107c8ede4
+  metadata.gz: db15484b5cec99715f23c35431a3aaa1e2f859d09093860bc00d57395e541542694bf1422d19193d520b245ca5732a375da81efe19cf4da3f6ddb5918bda6636
+  data.tar.gz: 9262f1a2299054ef678005c7a1f3541f2ca7c62b8af8960a64b878ab16315a9c18c2e81c342bf52699077c583f0000ce20e3c27089669591b828c127182bdac9

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -1,13 +1,14 @@
 # RandomOrgHttpApi
+[![Gem Version](https://badge.fury.io/rb/random_org_http_api.svg)](http://badge.fury.io/rb/random_org_http_api)
 
 Realization of old [HTTP API](http://www.random.org/clients/http/) provided by the random.org service.  
 Not to confuse to new [JSON-RPC API](https://api.random.org/json-rpc/1/) which now is in beta release.
 
 At present realized:  
 
-* generation of numbers
-* generation of numbers
-* generation of numbers
+* numbers generation
+* strings generation
+* sequence generation
 
 
 ## Installation
@@ -39,6 +40,13 @@ Or install it yourself as:
     g.generate_sequence(num: 5, len: 10, max: 10)
     => ["8", "9", "10", "3", "2", "7", "1", "5", "4", "6"]
 
+Check your quota  
+
+    g.quota
+    => ["1000000"]
+    
+More information about quota [here](http://www.random.org/clients/http/)
+
 ## More available parameters for generate_* methods
 
 ### generate_integers
@@ -69,7 +77,7 @@ More information about available parameters on [http://www.random.org/clients/ht
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/random_org_http_api/fork )
+1. Fork it ( https://github.com/istickz/random_org_http_api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

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

data/lib/random_org_http_api/configuration.rb

@@ -15,15 +15,15 @@ module RandomOrgHttpApi
 
     # Query templates
     # Integer
-    INTEGER_QUERY_PARAMS = [:num, :min, :max, :col, :base, :format, :rnd]
+    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}"
 
     # String
-    STRING_QUERY_PARAMS = [:num, :len, :digits, :upperalpha, :loweralpha, :unique, :format, :rnd]
+    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_PARAMS = [:min, :max, :col, :format, :rnd]
+    SEQUENCE_QUERY_KEYS = [:min, :max, :col, :format, :rnd]
     SEQUENCE_QUERY_TEMPLATE = "/sequences/?min=%{min}&max=%{max}&col=%{col}&format=%{format}&rnd=%{rnd}"
 
   end

data/lib/random_org_http_api/generator.rb

@@ -4,50 +4,70 @@ module RandomOrgHttpApi
     include RandomOrgHttpApi::Configuration
 
     def generate_integers(params = {})
-      request('integer', params)
+      integers_query = query('integer', params)
+      request(DOMAIN, integers_query)
     end
 
     def generate_strings(params = {})
-      request('string', params)
+      strings_query = query('string', params)
+      request(DOMAIN, strings_query)
     end
 
     def generate_sequence(params = {})
-      request('sequence', params)
+      sequence_query = query('sequence', params)
+      request(DOMAIN, sequence_query)
+    end
+
+    # Quota Checker
+    def quota
+      quota_query = "/quota/?ip=#{ip}&format=plain"
+      request(DOMAIN, quota_query).first.to_i
     end
 
     private
 
     # Метод запроса на сайт random.org
-    def request(object_type, params)
-      # В зависимости от типа получаемого объекта валидируем параметры и подставляем в нужный темплейт
+    def request(domain, query)
+      # Создаем запрос
+      res = Net::HTTP.get_response(domain, query)
+      # Если все хорошо, то возвращаем форматированный ответ,
+      # если нет, то показываем ответ ошибки сервера.
+      res.is_a?(Net::HTTPSuccess) ? res.body.split : res.body.strip
+    end
+
+    # Метод для генерации запроса
+    def query(object_type, params)
+      # Совмещаем параметры по умолчанию с параметами, который передал пользователь
+      all_params = DEFAULT_QUERY_PARAMS.merge(params)
+      # В зависимости от типа объекта, который нужно сгенерировать, оставляем только нужные для него параметры.
       case object_type
         when 'integer' then
-          all_params = permit_params(DEFAULT_QUERY_PARAMS, params, INTEGER_QUERY_PARAMS)
-          query  = generate_query(all_params, INTEGER_QUERY_TEMPLATE)
+          right_params = permit_params(all_params, INTEGER_QUERY_KEYS)
+          insert_params(right_params, INTEGER_QUERY_TEMPLATE)
         when 'string' then
-          all_params = permit_params(DEFAULT_QUERY_PARAMS, params, STRING_QUERY_PARAMS)
-          query  = generate_query(all_params, STRING_QUERY_TEMPLATE)
+          right_params = permit_params(all_params, STRING_QUERY_KEYS)
+          insert_params(right_params, STRING_QUERY_TEMPLATE)
         when 'sequence' then
-          all_params = permit_params(DEFAULT_QUERY_PARAMS, params,  SEQUENCE_QUERY_PARAMS)
-          query  = generate_query(all_params, SEQUENCE_QUERY_TEMPLATE)
+          right_params = permit_params(all_params, SEQUENCE_QUERY_KEYS)
+          insert_params(right_params, SEQUENCE_QUERY_TEMPLATE)
       end
-      # Создаем запрос
-      res = Net::HTTP.get_response(DOMAIN, query)
-      # Если все хорошо, то возвращаем форматированный ответ,
-      # если нет, то показываем ответ ошибки сервера.
-      res.is_a?(Net::HTTPSuccess) ? res.body.split : res.body.strip
     end
 
     # Метод оставляющий только нужные параметры.
-    def permit_params(default_params, params, required_params )
-      @params = default_params.merge(params)
-      @params = @params.select {|k,v| required_params.include?(k) }
+    def permit_params(params, required_keys)
+      params.select { |k| required_keys.include?(k) }
     end
 
-    # Метод подстановки параметров в темплейт. Параметр должен быть хешем.
-    def generate_query(params, template)
+    # Метод подстановки параметров в темплейт.
+    # Параметры должны передаваться в хеше
+    def insert_params(params, template)
       template % params
     end
 
+    def ip
+      uri = URI('http://whatismyip.akamai.com')
+      Net::HTTP.get(uri)
+    end
+
   end
 end

data/lib/random_org_http_api/version.rb

@@ -1,3 +1,3 @@
 module RandomOrgHttpApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/random_org_http_api.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   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

@@ -0,0 +1,63 @@
+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'}
+      required_keys = [:a, :b]
+      expect(@generator.send(:permit_params, params, required_keys)).to eq({a: 'A', b: 'B'})
+    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 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)
+    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
+
+  describe '#request' do
+    domain = 'www.random.org'
+
+    it 'should do 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)
+    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
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'random_org_http_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: random_org_http_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Temur Fatkulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: At present realized generation for numbers, strings and sequences
 email:
 - temur.fatkulin@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +70,8 @@ files:
 - lib/random_org_http_api/generator.rb
 - lib/random_org_http_api/version.rb
 - random_org_http_api.gemspec
+- spec/random_org_http_api/generator_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/istickz/random_org_http_api
 licenses:
 - MIT
@@ -79,4 +96,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Realization of old HTTP API provided by the random.org service
-test_files: []
+test_files:
+- spec/random_org_http_api/generator_spec.rb
+- spec/spec_helper.rb