gorillapi 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e00828a6ad86bbed30b71d068dacf3c337b1d55
+  data.tar.gz: 9ea2749700b081aae453a019f630d91792e65d81
+SHA512:
+  metadata.gz: a2f154b2b7e242d58fa45ed992d8abcafc7ca80693d51ea01f11cf1307aca27677a9d6c427645f7b324d3bc43da494eb59c68052b6eb59b66269feae8908561d
+  data.tar.gz: 3dd5383679c559a13e8116374dd44145fe167d00e0c83a7cb473c4edd40863e49040e0e4607823083a3646a69fb47af28ac6fa9b031acc288db2ca6418be431b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Evans
+
+MIT License
+
+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,68 @@
+# Gorilla Api
+
+### Usage in your Rails app
+
+````
+require 'gorillapi'
+
+module Api
+  extend Gorillapi
+  extend self
+  
+  test_api url: 'staging.domain.com'
+  
+  header header_name: 'codewranglers.gorillapi',
+         api_key:     'ABC123',
+         format: 	   'json',
+         version:      1
+  
+  def ping
+    get "/api/v1/ping"
+  end
+  
+  def add_task
+    post "/api/v1/tasks", params: { task: { name: 'Test Api' } }
+  end 
+end
+
+Api.add_task # =>
+
+
+Request Details: Add Task
+---------------------------------------------
+Url:          staging.domain.com
+Request:      POST
+Endpoint:     /api/v1/tasks
+Content-Type  application/json
+Accept:       application/vnd.codewranglers.gorillapi-v1+json
+Api Token:    ABC123
+Params:       { 'task' => { 'name' => 'Test Api' } }
+
+
+cURL Request:
+---------------------------------------------
+curl -X POST -k -i -v -H "Content-Type: application/json" -H "Accept: application/vnd.codewranglers.gorillapi-v1+json" -H "AUTHORIZATION: ABC123"  http://staging.domain.com/api/v1/tasks
+
+
+Api Call Results:
+---------------------------------------------
+HTTP/1.1 201 Created
+Server: nginx/1.4.7
+Date: Wed, 23 Apr 2014 23:33:42 GMT
+Content-Type: application/json; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+Status: 201 Created
+X-Frame-Options: SAMEORIGIN
+X-XSS-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+Vary: Accept-Encoding
+ETag: "260ca9dd8a4577fc00b7bd5810298076"
+Cache-Control: max-age=0, private, must-revalidate
+Set-Cookie: request_method=POST; path=/
+X-Request-Id: 75af1009-cd70-4304-9b22-0d7e263ca161
+X-Runtime: 0.026264
+
+success
+````
+

data/Rakefile

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

data/gorillapi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gorillapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gorillapi"
+  spec.version       = Gorillapi::VERSION
+  spec.authors       = ["Robert Evans"]
+  spec.email         = ["robert@codewranglers.org"]
+  spec.summary       = %q{A simple interface to test an Api}
+  spec.description   = %q{A simple interface to test an Api}
+  spec.homepage      = ""
+  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 "minitest"
+
+  spec.add_dependency 'activesupport'
+end

data/lib/gorillapi.rb

@@ -0,0 +1,24 @@
+require 'active_support/inflector'
+require 'json'
+
+require_relative "gorillapi/version"
+
+require_relative "gorillapi/curl_builder"
+require_relative 'gorillapi/request_builder'
+require_relative 'gorillapi/request_methods'
+
+module Gorillapi
+  include RequestMethods
+
+  def test_api(url: '')
+    self.class_eval("def url;'#{url}';end")
+  end
+
+  def header(header_name: '', api_key: '', format: 'json', version: 1)
+    self.class_eval("def content_type;'application/#{format}';end")
+    self.class_eval("def format;'#{format}';end")
+    self.class_eval("def version;'#{version}';end")
+    self.class_eval("def token;'#{api_key}';end")
+    self.class_eval("def accept_header; 'application/vnd.#{header_name}-v#{version}+#{format}'; end")
+  end
+end

data/lib/gorillapi/curl_builder.rb

@@ -0,0 +1,30 @@
+
+module Gorillapi
+  module CurlBuilder
+    def request_string
+      <<-EOF
+curl -X #{request_method} -k -i -v #{content_header} #{accept} #{authorization} #{add_params} #{host}
+      EOF
+    end
+
+    def authorization
+      "-H \"AUTHORIZATION: #{token}\""
+    end
+
+    def accept
+      "-H \"Accept: #{accept_header}\""
+    end
+
+    def content_header
+      "-H \"Content-Type: #{content_type}\""
+    end
+
+    def add_params
+      "-d '#{params.to_json}'" unless params.nil? || params.empty? || params == ''
+    end
+
+    def host
+      "http://#{url}#{path}"
+    end
+  end
+end

data/lib/gorillapi/request_builder.rb

@@ -0,0 +1,21 @@
+module Gorillapi
+  class RequestBuilder
+    include CurlBuilder
+
+    attr_reader :request_method, :path, :params, :url, :content_type, :accept_header, :token
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value) unless value.nil? || value.empty?
+      end
+    end
+
+    def send
+      `#{request_string}`
+    end
+
+    def print
+      request_string
+    end
+  end
+end

data/lib/gorillapi/request_methods.rb

@@ -0,0 +1,124 @@
+
+module Gorillapi
+  module PrintResponse
+    def print_request(builder, print_only)
+
+      case print_only
+      when 'curl'
+        show_curl_request(builder)
+      when 'details'
+        request_details
+      else
+        request_details
+        show_curl_request(builder)
+      end
+
+      true
+    end
+
+    def request_details
+      puts
+      puts "-" * 100
+      puts
+      puts "Request Details: #{@caller}"
+      puts "-" * 100
+      puts "Url:          #{url}"
+      puts "Request:      #{@request_method}"
+      puts "Endpoint:     #{@path}"
+      puts "Content-Type  #{content_type}"
+      puts "Accept:       #{accept_header}"
+      puts "Api Token:    #{token}"
+      puts "Params:       #{@params}"
+      puts
+    end
+
+    def print_results(builder, results)
+      request_details
+      show_curl_request(builder)
+
+      puts
+      puts "Api Call Results:"
+      puts "-" * 100
+      puts results
+      puts
+    end
+
+    def show_curl_request(builder)
+      puts
+      puts "cURL Request:"
+      puts "-" * 100
+      puts builder.print
+      puts
+    end
+  end
+
+  module RequestMethods
+    include PrintResponse
+
+    def handle_print(builder, print_only = false)
+      if print_only
+        print_request(builder, print_only)
+      else
+        results = builder.send
+        print_results(builder, results)
+      end
+    end
+
+
+    def get(path, print_only = false, params: {})
+      @caller           = caller[0][/`.*'/][1..-2].humanize.titleize
+      @request_method   = 'GET'
+      @path             = path
+      @params           = params
+
+      builder           = build_request
+      handle_print(builder, print_only)
+    end
+
+
+    def post(path, print_only = false, params: {})
+      @caller           = caller[0][/`.*'/][1..-2].humanize.titleize
+      @request_method   = 'POST'
+      @path             = path
+      @params           = params
+
+      builder           = build_request
+      handle_print(builder, print_only)
+    end
+
+
+    def put(path, print_only = false, params: {})
+      @caller           = caller[0][/`.*'/][1..-2].humanize.titleize
+      @request_method   = 'PUT'
+      @path             = path
+      @params           = params
+
+      builder           = build_request
+      handle_print(builder, print_only)
+    end
+
+    def delete(path, print_only = false, params: {})
+      @caller           = caller[0][/`.*'/][1..-2].humanize.titleize
+      @request_method   = 'DELETE'
+      @path             = path
+      @params           = params
+
+      builder           = build_request
+      handle_print(builder, print_only)
+    end
+
+    def build_request
+      options = {
+        request_method: @request_method,
+        url:            url,
+        path:           @path,
+        params:         @params,
+        content_type:   content_type,
+        accept_header:  accept_header,
+        token:          token,
+      }
+
+      RequestBuilder.new(options)
+    end
+  end
+end

data/lib/gorillapi/version.rb

@@ -0,0 +1,3 @@
+module Gorillapi
+  VERSION = "0.0.11"
+end

data/test/gorillapi_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class GorillapiTest < Minitest::Test
+
+  def test_api_settings
+    assert_equal 'test.api',          Gorilla.url
+    assert_equal "123abc",            Gorilla.token
+    assert_equal "json",              Gorilla.format
+    assert_equal '1',                 Gorilla.version
+    assert_equal 'application/json',  Gorilla.content_type
+
+    assert_equal "application/vnd.gorilla_header-v1+json",
+                    Gorilla.accept_header
+  end
+
+
+  def test_get_with_print
+    assert Gorilla.ping(true)
+    assert Gorilla.ping('curl')
+    assert Gorilla.ping('details')
+  end
+
+  def test_get_without_print
+    # assert Gorilla.user
+  end
+
+  def test_post_with_print
+    assert Gorilla.create_post(true)
+    assert Gorilla.create_post('curl')
+    assert Gorilla.create_post('details')
+  end
+
+  def test_put_with_print
+    assert Gorilla.update_post(true)
+    assert Gorilla.update_post('curl')
+    assert Gorilla.update_post('details')
+  end
+
+  def test_delete_with_print
+    assert Gorilla.delete_post(true)
+    assert Gorilla.delete_post('curl')
+    assert Gorilla.delete_post('details')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../lib/gorillapi'
+
+module Gorilla
+  extend self, Gorillapi
+
+  test_api  url: 'test.api'
+  header    header_name:  'gorilla_header',
+            api_key:      '123abc',
+            format:       'json',
+            version:      1
+
+  def ping(print_only = false)
+    get "/api/v1/ping", print_only
+  end
+
+  def user
+    get "/api/v1/user", params: { id: 1 }
+  end
+
+  def create_post(print_only = false)
+    post "/api/v1/post", print_only, params: {
+      title: 'My Post',
+      content: 'Lorem ipsum....',
+    }
+  end
+
+  def update_post(print_only = false)
+    put "/api/v1/post", print_only, params: {
+      id: 1,
+      title: 'My Post',
+      content: 'Lorem ipsum....',
+    }
+  end
+
+  def delete_post(print_only = false)
+    delete "/api/v1/post", print_only, params: {
+      id: 1
+    }
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: gorillapi
+version: !ruby/object:Gem::Version
+  version: 0.0.11
+platform: ruby
+authors:
+- Robert Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: activesupport
+  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'
+description: A simple interface to test an Api
+email:
+- robert@codewranglers.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gorillapi.gemspec
+- lib/gorillapi.rb
+- lib/gorillapi/curl_builder.rb
+- lib/gorillapi/request_builder.rb
+- lib/gorillapi/request_methods.rb
+- lib/gorillapi/version.rb
+- test/gorillapi_test.rb
+- test/test_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple interface to test an Api
+test_files:
+- test/gorillapi_test.rb
+- test/test_helper.rb