randomapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58f1b036922c600189cb89ddd6bae4c1f72ab6c3
+  data.tar.gz: e22a8502351a98b2426c6ee29baf2abb0720efbc
+SHA512:
+  metadata.gz: e6ec12f62661a2611b3c1b1a9cf76fa8f0e2e9ce814ba70bfbed4242ead0440375f4c95254de63e0b0337d6c5564ff1ec45376fa39134d3226c8a56c8428917f
+  data.tar.gz: e00a2664bfd7ba7528ad75fe5d1d8b9e92d19e459654d928cafb6f954a22bb3c8fa26aa2e23505ad15935f3a738db190f4ff9cab5fdd9ab8ab943e13f6641be8

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in randomapi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    randomapi (0.0.2)
+      faraday (>= 0.7, < 0.10)
+      faraday_middleware (>= 0.8, < 0.10)
+      hashie (>= 0.4.0)
+      multi_json (~> 1.0, >= 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (3.4.0)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  randomapi!

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Denis Kuznetsov
+
+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,42 @@
+# randomapi-ruby
+API to access data from https://randomapi.com
+
+#Installation
+Bundler:
+------------
+	gem install randomapi
+	
+#Initialization
+If you use only 1 API key & API id, it makes sense to pass them in the initializer:
+```ruby
+RandomApi.configure do |config|
+  config.api_key = "YOUR_API_KEY_HERE"
+  config.api_id = "YOUR_API_ID_HERE"
+end
+```
+
+#Client creation
+To make requests you need to create a client:
+```ruby
+client = RandomApi.client # uses api key & id from initializer
+client = RandomApi.client(api_key: "ANOTHER_API_KEY", api_id: "ANOTHER_API_ID") # passes key & id directly
+```
+  
+#Making calls
+```ruby
+client.request # makes request to API to return 1 result
+client.request(results: 5) # give me 5 results!
+client.request(results: 5, myvar: 1) # give me 5 results with variable "myvar" set to 1
+  ```
+## Contributing to randomapi
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make pull request
+
+License
+-------
+This code is free to use under the terms of the MIT license.
+
+## Copyright
+Copyright (c) 2015 Denis Kuznetsov.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/randomapi.rb

@@ -0,0 +1,13 @@
+require "randomapi/version"
+
+require File.expand_path('../randomapi/configuration', __FILE__)
+require File.expand_path('../randomapi/api', __FILE__)
+require File.expand_path('../randomapi/client', __FILE__)
+
+module RandomApi
+  extend Configuration
+
+  def self.client(options={})
+    RandomApi::Client.new(options)
+  end
+end

data/lib/randomapi/api.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+
+module RandomApi
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = RandomApi.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/randomapi/client.rb

@@ -0,0 +1,9 @@
+module RandomApi
+  class Client < API
+
+    def request(options = {})
+      get("", options)
+    end
+
+  end
+end

data/lib/randomapi/configuration.rb

@@ -0,0 +1,84 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module RandomApi
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring API
+    VALID_OPTIONS_KEYS = [
+      :api_key,
+      :api_id,
+      :adapter,
+      :connection_options,
+      :endpoint,
+      :format,
+      :proxy,
+      :user_agent
+    ].freeze
+
+    # By default, don't set api key
+    DEFAULT_API_KEY = nil
+
+    # By default, don't set api id
+    DEFAULT_API_ID = nil
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://randomapi.com/api/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    DEFAULT_USER_AGENT = ""
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [
+      :json].freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.api_key            = DEFAULT_API_KEY
+      self.api_id             = DEFAULT_API_ID
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/randomapi/connection.rb

@@ -0,0 +1,30 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module RandomApi
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {
+                     'Accept' => "application/#{format}",
+                     'User-Agent' => user_agent
+                     },
+        :proxy => proxy,
+        :url => endpoint,
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        unless raw
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          end
+        end
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/randomapi/request.rb

@@ -0,0 +1,46 @@
+require 'openssl'
+
+module RandomApi
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false)
+      make_request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false)
+      make_request(:post, path, options, raw)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false)
+      make_request(:put, path, options, raw)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false)
+      make_request(:delete, path, options, raw)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def make_request(method, path, options, raw=false)
+      options.merge!({:key => api_key, :id => api_id })
+
+      response = connection(raw).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      return response if raw
+      return response.body
+    end
+
+  end
+end

data/lib/randomapi/version.rb

@@ -0,0 +1,3 @@
+module RandomApi
+  VERSION = "0.0.1"
+end

data/randomapi.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'randomapi/version'
+Gem::Specification.new do |spec|
+  spec.name          = "randomapi"
+  spec.version       = RandomApi::VERSION
+  spec.authors       = ["Denis Kuznetsov"]
+  spec.email         = ["denis@f7.ru"]
+  spec.summary       = %q{Gets data from randomapi.com}
+  spec.description   = %q{Gets data from randomapi.com}
+  spec.homepage      = "https://github.com/byteg/randomapi-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency('faraday', ['>= 0.7', '< 0.10'])
+  spec.add_runtime_dependency('faraday_middleware', ['>= 0.8', '< 0.10'])
+  spec.add_runtime_dependency('multi_json', '>= 1.0.3', '~> 1.0')
+  spec.add_runtime_dependency('hashie',  '>= 0.4.0')
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: randomapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denis Kuznetsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Gets data from randomapi.com
+email:
+- denis@f7.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- License.txt
+- README.md
+- Rakefile
+- lib/randomapi.rb
+- lib/randomapi/api.rb
+- lib/randomapi/client.rb
+- lib/randomapi/configuration.rb
+- lib/randomapi/connection.rb
+- lib/randomapi/request.rb
+- lib/randomapi/version.rb
+- randomapi.gemspec
+homepage: https://github.com/byteg/randomapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Gets data from randomapi.com
+test_files: []
+has_rdoc: