namira 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d00e69f0acebc986d43bdb7dbbb87cf6b4553bf
+  data.tar.gz: 799ce7d533162d292cc7c1cd79d584bd4c4385b7
+SHA512:
+  metadata.gz: 6f5a074d77c86c01bf9729ea300e81b7c8a54bf67fe7c856040249b4e7177dcd7621f70cfee91549e71df1502311ec43399262e8f16c659ac2b7866eb137e04c
+  data.tar.gz: c55ada08736f2c6bb53c182f1929d5f8be3d1708c7946dbc09005fb0a81fa5580a70bae6205bf07024382c080842a9fe24ee76d31697eec7e91cf6fcc9080264

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Skylar Schipper
+
+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,41 @@
+# Namira
+
+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/namira`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'namira'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install namira
+
+## Usage
+
+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/[USERNAME]/namira.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "namira"
+require "pry"
+
+Namira.configure do |config|
+  config.user_agent           = 'test'
+  config.headers.accept       = 'application/json'
+  config.headers.content_type = 'application/json'
+end
+
+Pry.start

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/namira/backend.rb

@@ -0,0 +1,59 @@
+module Namira
+  class Backend
+
+    #
+    # This allows anyone to substitute in their own networking stack.
+    #
+    # Any class that implements this method and resturns a `Namira::Response` object can be a fully qualified backend
+    #
+    # The required params are
+    #
+    #  uri:          The URI to fetch
+    #  method:       The HTTP method to use, expressed as a Symbol i.e. `:get`
+    #  headers:      The full HTTP headers to send from the request expressed as a Hash
+    #  max_redirect: The maximum number of redirects to follow.  Passed from the Request
+    #  timeout:      The number of seconds before a timeout should occure
+    #
+    # This class is 100% capable of fufilling all Namira's needs.  But this is an option if you really need to provide a custom networking backend
+    #
+    def self.send_request(uri:, method:, headers:, max_redirect:, timeout:, body:)
+      Backend.new.send_request(uri, method, headers, max_redirect, timeout, body)
+    end
+
+    def send_request(uri, method, headers, max_redirect, timeout, body)
+      @redirect_count ||= 0
+      fail Errors::TooManyRedirects, "Max number of redirects #{@redirect_count} for #{uri}" if @redirect_count > max_redirect
+
+      if defined?(::Rails)
+        Rails.logger.debug "#{method.to_s.upcase} - #{uri}"
+      else
+        puts "#{method.to_s.upcase} - #{uri}"
+      end
+
+      http = HTTP.timeout(
+          :per_operation,
+          write:   timeout,
+          connect: timeout,
+          read:    timeout
+        )
+        .headers(headers)
+
+      response = http.send(method, uri, body: body)
+
+      case response.status
+      when 200..299
+        Namira::Response.new(response)
+      when 301, 302
+        @redirect_count += 1
+        location = response.headers['Location']
+        fail Errors::RedirectError, "Request redirected but no location was supplied" if location.nil?
+        send_request(location, method, headers, max_redirect, timeout, body)
+      else
+        fail Errors::HTTPError.new("http_error/#{response.status}", response.status)
+      end
+
+    rescue HTTP::TimeoutError => e
+      fail Namira::Errors::Timeout.new(e.message)
+    end
+  end
+end

data/lib/namira/config.rb

@@ -0,0 +1,38 @@
+module Namira
+  class Config
+    attr_accessor :max_redirect, :timeout, :backend, :user_agent
+
+    DEFAULT_SETTINGS = {
+      max_redirect: 3,
+      timeout:      5.0,
+      backend:      nil,
+      user_agent:   "Namira/#{Namira::VERSION}"
+    }
+
+    def initialize
+      DEFAULT_SETTINGS.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def headers
+      @headers ||= ConfigHash.new
+    end
+  end
+
+  class ConfigHash < Hash
+    def method_missing(name, *args)
+      if name.to_s =~ /=$/
+        self[name.to_s.gsub(/=$/, '')] = args.first
+      else
+        self[name]
+      end
+    end
+  end
+
+  def self.configure
+    @config ||= Config.new
+    yield(@config) if block_given?
+    @config
+  end
+end

data/lib/namira/errors/base.rb

@@ -0,0 +1,7 @@
+module Namira
+  module Errors
+    class Base < StandardError
+
+    end
+  end
+end

data/lib/namira/errors/http_error.rb

@@ -0,0 +1,12 @@
+module Namira
+  module Errors
+    class HTTPError < Base
+      attr_reader :status
+
+      def initialize(msg, status)
+        @status = status
+        super(msg)
+      end
+    end
+  end
+end

data/lib/namira/errors/redirect_error.rb

@@ -0,0 +1,6 @@
+module Namira
+  module Errors
+    class RedirectError < Base
+    end
+  end
+end

data/lib/namira/errors/timeout.rb

@@ -0,0 +1,7 @@
+module Namira
+  module Errors
+    class Timeout < Base
+
+    end
+  end
+end

data/lib/namira/errors/too_many_redirects.rb

@@ -0,0 +1,7 @@
+module Namira
+  module Errors
+    class TooManyRedirects < Base
+
+    end
+  end
+end

data/lib/namira/errors.rb

@@ -0,0 +1,5 @@
+require_relative 'errors/base'
+require_relative 'errors/http_error'
+require_relative 'errors/too_many_redirects'
+require_relative 'errors/redirect_error'
+require_relative 'errors/timeout'

data/lib/namira/extensions/hash_key_path.rb

@@ -0,0 +1,23 @@
+module Namira
+  module Extensions
+    module HashKeyPath
+      def value_for_key_path(path)
+        components = path.split('.')
+        value = self
+        components.each do |key|
+          break if value.nil?
+
+          value = case value
+          when Hash
+            value[key] || value[key.to_sym]
+          when Array
+            value[key.to_i]
+          else
+            nil
+          end
+        end
+        value
+      end
+    end
+  end
+end

data/lib/namira/query_builder.rb

@@ -0,0 +1,19 @@
+module Namira
+  class QueryBuilder
+    def initialize
+      @backing = {}
+    end
+
+    def method_missing(name, *args)
+      if name.to_s =~ /=$/
+        @backing[name.to_s.gsub(/=$/, '')] = args.first
+      else
+        @backing[name.to_s]
+      end
+    end
+
+    def to_s
+      @backing.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+  end
+end

data/lib/namira/request.rb

@@ -0,0 +1,52 @@
+require 'http'
+
+module Namira
+  class Request
+    attr_reader :uri, :http_method
+
+    def initialize(uri:, http_method: :get, headers: {}, body: nil)
+      @uri          = uri
+      @http_method  = http_method
+      @headers      = headers || {}
+      @body         = body
+      @timeout      = Namira.configure.timeout
+      @max_redirect = Namira.configure.max_redirect
+      @backend      = Namira.configure.backend || Namira::Backend
+      @user_agent   = Namira.configure.user_agent
+    end
+
+    def send_request
+      @response ||= _send_request(uri)
+    end
+
+    def response
+      send_request
+    end
+
+    private
+
+    def build_headers
+      {}.tap do |headers|
+        headers['User-Agent'] = @user_agent
+        Namira.configure.headers.each do |k, v|
+          key = k.split('_').map { |s| s.capitalize }.join('-')
+          headers[key] = v
+        end
+        @headers.each do |k, v|
+          headers[k] = v
+        end
+      end
+    end
+
+    def _send_request(uri)
+      @backend.send_request(
+        uri:          uri,
+        method:       http_method,
+        headers:      build_headers,
+        max_redirect: @max_redirect,
+        timeout:      @timeout,
+        body:         @body
+      )
+    end
+  end
+end

data/lib/namira/response.rb

@@ -0,0 +1,19 @@
+module Namira
+  class Response
+    def initialize(backing)
+      @backing = backing
+    end
+
+    def from_json
+      @json ||= JSON.parse(@backing.body)
+    end
+
+    def method_missing(name, *args)
+      if @backing.respond_to?(name)
+        @backing.send(name, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/namira/version.rb

@@ -0,0 +1,3 @@
+module Namira
+  VERSION = "0.1.0"
+end

data/lib/namira.rb

@@ -0,0 +1,10 @@
+require 'namira/version'
+require 'namira/request'
+require 'namira/response'
+require 'namira/errors'
+require 'namira/config'
+require 'namira/query_builder'
+require 'namira/backend'
+require 'namira/extensions/hash_key_path'
+
+Hash.include(Namira::Extensions::HashKeyPath)

data/namira.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'namira/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "namira"
+  spec.version       = Namira::VERSION
+  spec.authors       = ["Skylar Schipper"]
+  spec.email         = ["ss@schipp.co"]
+
+  spec.summary       = "A simple wrapper around HTTP"
+  spec.description   = "This is a simple wrapper around HTTP"
+  spec.homepage      = "https://github.com/skylarsch/namira"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency 'http', '~> 2.0.0'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: namira
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Skylar Schipper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: This is a simple wrapper around HTTP
+email:
+- ss@schipp.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/namira.rb
+- lib/namira/backend.rb
+- lib/namira/config.rb
+- lib/namira/errors.rb
+- lib/namira/errors/base.rb
+- lib/namira/errors/http_error.rb
+- lib/namira/errors/redirect_error.rb
+- lib/namira/errors/timeout.rb
+- lib/namira/errors/too_many_redirects.rb
+- lib/namira/extensions/hash_key_path.rb
+- lib/namira/query_builder.rb
+- lib/namira/request.rb
+- lib/namira/response.rb
+- lib/namira/version.rb
+- namira.gemspec
+homepage: https://github.com/skylarsch/namira
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple wrapper around HTTP
+test_files: []