scoutie 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 275e0394544020b2c28bb53aa8d7512be9e3478b
+  data.tar.gz: 0a7a580d38bc36fa6e3a0cdb5184c8adab38cca7
+SHA512:
+  metadata.gz: 15dc7cab6b0c1e42951794f2e0e5d7db0dc18902af653ee80c59c2075bbea40c0143782cf66ef1ed71c09e463b660a50e9f35cf6ab04cd136cd82000aba2b5ce
+  data.tar.gz: 7b60b6e4839e4203c927d7e4a17d462176cb5d72761283047316788a6684d77e1e69e16be5c92285601ba8c8c1f433114fc7e181c06344a672d1bd03d6f0e3ea

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brittany Martin
+
+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,49 @@
+# Scoutie
+
+A rake task to check the status code of a JSON request
+
+![alt tag](https://github.com/Brit200313/scoutie/blob/master/img/scoutie.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scoutie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoutie
+
+## Usage
+
+Have a JSON API you want to test as you're coding along? 
+
+Simply run:
+
+    $ rake scoutie[url]
+
+and Scoutie will return a response code and recommendation on proceeding. 
+
+## Examples
+
+    $ rake scoutie["http://jsonip.com"]                                                                                                                                          ⏎ ✱ ◼
+    Response: 200
+    Sweet! You're golden to use that API.
+
+    $ rake scoutie["https://www.yammer.com/api/v1/subscriptions/to_user/:id.json"]                                                                                                 ✱ ◼
+    Response: 401
+    Nice try! Someone is missing an authorization token.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scoutie/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+import "lib/tasks/scout.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r mega_lotto -I ./lib"
+end
+
+

data/lib/scoutie.rb

@@ -0,0 +1,10 @@
+require "scoutie/version"
+require "scoutie/status"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module Scoutie
+end

data/lib/scoutie/status.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module Scoutie
+  class Status
+    def get_status(url) 
+      api_response = HTTParty.get(url, :query => {:output => 'json'})
+      status = api_response.response.code.to_i
+      puts "Response: #{status}"
+
+      case status
+      when 200
+        puts "Sweet! You're golden to use that API."
+      when 207
+        puts "Yikes! You sent a destructive operation (POST, PUT, DELETE) against more than one resource and the operations against each indiviudal resource did not share a common outcome."
+      when 300 || 301
+        puts "Stop trying to make fetch happen. Not ideal, would be better if the response was a 200."
+      when 400
+        puts "Hold up. You're sending a malformed request to the API or the request cannot be validated."
+      when 401
+        puts "Nice try! Someone is missing an authorization token."
+      when 403
+        puts "Hate to be vague but this means you're doing something the API is not happy with. Better investigate."
+      when 404
+        puts "Manipulative much? This means that the resource you wanted to manipulate could not be found."
+      when 409
+        puts "Your request is syntactically correct but violates a business rule. Better take a closer look."
+      when 410
+        puts "N'Sync says your request is G-O-N-E. The requested resource is no longer available at the server and no forwarding address is known."
+      when 500
+        puts "This is embarrassing. This indicates a technical failure inside the API."
+      when 503
+        puts "Busy busy busy! The API is too busy to accept your request, or if your access to the API has been temporarily suspended due to overuse."
+      else
+        puts "Your request returned #{api_response} -- Scoutie has no idea what to do with that."
+      end
+
+      status
+    end
+  end
+end

data/lib/scoutie/version.rb

@@ -0,0 +1,3 @@
+module Scoutie
+  VERSION = "0.0.2"
+end

data/lib/tasks/scout.rake

@@ -0,0 +1,11 @@
+require 'scoutie'
+
+desc 'checks the HTTP status code of a JSON request'  
+task :scoutie, :url do |t, args|
+  url = args[:url] || 'http://www.telize.com/geoip?callback=?'
+  s = Scoutie::Status.new.get_status(url)
+end
+
+
+
+

data/scoutie.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scoutie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoutie"
+  spec.version       = Scoutie::VERSION
+  spec.authors       = ["Brittany Martin"]
+  spec.email         = ["brittany.jill.martin@gmail.com"]
+  spec.summary       = %q{Easy to use rake task to check JSON API calls}
+  spec.description   = %q{Easy to use rake task to check JSON API calls}
+  spec.homepage      = "https://github.com/Brit200313/scoutie"
+  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 "httparty"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/lib/scoutie_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Scoutie
+  describe Status do
+    describe "#get_status" do
+      let(:status) { Status.new }
+
+      it "returns a 200 status code when available" do
+        s = status.get_status 'http://www.telize.com/geoip?callback=?'
+        expect(s).to be(200)
+      end
+
+      it "returns a 401 status code when denied" do
+        s = status.get_status 'https://www.yammer.com/api/v1/subscriptions/to_user/:id.json'
+        expect(s).to be(401)
+      end
+
+      it "returns a 403 status code when denied" do
+        s = status.get_status 'http://content.guardianapis.com/.json'
+        expect(s).to be(403)
+      end
+
+      it "throws exception if no protocol provided" do
+        expect{ status.get_status 'bananas!' }.to raise_error(URI::InvalidURIError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'scoutie'
+require 'pry'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: scoutie
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brittany Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Easy to use rake task to check JSON API calls
+email:
+- brittany.jill.martin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- img/scoutie.png
+- lib/.DS_Store
+- lib/scoutie.rb
+- lib/scoutie/.DS_Store
+- lib/scoutie/status.rb
+- lib/scoutie/version.rb
+- lib/tasks/scout.rake
+- scoutie.gemspec
+- spec/lib/scoutie_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Brit200313/scoutie
+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: Easy to use rake task to check JSON API calls
+test_files:
+- spec/lib/scoutie_spec.rb
+- spec/spec_helper.rb