gradesfirst 0.3.0 → 0.3.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzdkMjkxNTYwZmZmMjljMjQzZTA0NWI3NGNmNDRjNmE1NDY0YmY3Zg==
+  data.tar.gz: !binary |-
+    MmFiNTQxMjRlZWY4ZjM5NmJmNjFmMjc5ODc4NGZiYzBmYzFiZjM3NA==
+SHA512:
+  metadata.gz: !binary |-
+    MTJjOTE0YmM5MjNmZDVhNjlmZmJjMjk3MGQ0NzhjNmZmMDJjNjQyNTNhYWMw
+    YzBmOTllYTdhMzdhYzg5NDQzODllNGNlYjc3YWVjNzk4OGRlOWE0NDZlZDll
+    N2MwMjIzMGIxMTI2ODMwMDAzMjZlN2I5MzhkOThkYzBmOWFjNjM=
+  data.tar.gz: !binary |-
+    OWY0OWE5NTk5NDc5NjcyN2Q5YjQzYTQyMmI3Zjc2YWY5NWZlYjk1ZmJlZjI2
+    YzViZjc3YTE4ZWNkYmYyYTgyMjM2NTBkY2Y5NTNkOWNmZDg4OGQxMTYxNjYw
+    MTFiMTA4YjE1M2RhNDQ3ZjczYWEyZWU0NjZiNmNkZTY0MThiYTY=

data/Gemfile

@@ -6,3 +6,4 @@ gem 'thor', '~> 0.18.1'
 gem 'webmock', '~> 1.16.0'
 gem 'pry'
 gem 'pry-debugger'
+gem 'http_magic', '~> 0.1'

data/Gemfile.lock

@@ -12,6 +12,7 @@ GEM
       debugger-ruby_core_source (~> 1.2.4)
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.4)
+    http_magic (0.1.1)
     method_source (0.8.2)
     minitest (4.7.5)
     pry (0.9.12.4)
@@ -33,6 +34,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  http_magic (~> 0.1)
   minitest (~> 4.7.0)
   pry
   pry-debugger

data/gradesfirst.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = "gradesfirst"
-  s.version = "0.3.0"
+  s.version = "0.3.2"
   s.summary = "GradesFirst command line utility for developers."
   s.description = "This utility will help manage the various tasks developers need to do on their workstation such as database updates."
   s.license = "MIT"
@@ -23,5 +23,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency('thor', '~> 0.18.1')
+  s.add_dependency('http_magic', '~> 0.1.2')
   s.add_development_dependency('minitest', '~> 4.7.0')
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: gradesfirst
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - GradesFirst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,15 +20,27 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: http_magic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -72,10 +81,6 @@ files:
 - lib/gradesfirst/task_list_command.rb
 - lib/gradesfirst/task_move_command.rb
 - lib/gradesfirst/task_toggle_command.rb
-- lib/http_magic.rb
-- lib/http_magic/api.rb
-- lib/http_magic/request.rb
-- lib/http_magic/uri.rb
 - lib/pivotal_tracker.rb
 - test/branch_command_test.rb
 - test/cli_test.rb
@@ -94,10 +99,6 @@ files:
 - test/fixtures/task_toggled.txt
 - test/fixtures/tasks.json
 - test/fixtures/tasks.txt
-- test/http_magic/api/get_test.rb
-- test/http_magic/api/post_test.rb
-- test/http_magic/request_test.rb
-- test/http_magic/uri_test.rb
 - test/support/pivotal_test_helper.rb
 - test/support/request_expectation.rb
 - test/task_add_command_test.rb
@@ -109,26 +110,25 @@ files:
 homepage: http://www.gradesfirst.com
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: GradesFirst command line utility for developers.
 test_files: []

data/lib/http_magic.rb

@@ -1,4 +0,0 @@
-require 'http_magic/api'
-
-module HttpMagic
-end

data/lib/http_magic/api.rb

@@ -1,233 +0,0 @@
-require 'json'
-require 'http_magic/uri'
-require 'http_magic/request'
-
-module HttpMagic
-  # A magical class that interacts with HTTP resources with a minimal amount of
-  # configuration.
-  #
-  # Assuming an api where the url http://www.example.com/api/v1/foo/99 responds
-  # with the following.
-  #
-  # Header:
-  #
-  #   Content-Type: application/json
-  #
-  # Body:
-  #
-  #   {
-  #     "name": "Foo Bar"
-  #   }
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic::Api
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #     headers({'X-AuthToken' => 'token'})
-  #   end
-  #
-  #   ExampleApi.foo[99].get['name']
-  #   => "Foo Bar"
-  #
-  #   ExampleApi.foo.create.post(name: 'New Foo')
-  #   => { 'name' => 'New Foo' }
-  class Api < BasicObject
-    # Makes the new method private so that instances of this class and it's
-    # children can only be instantiated through the class method method_missing.
-    # This is needed to enforce the intended usage of HttpMagic where the class
-    # is configured to represent an http location. Once it is configured, the
-    # location is interacted with dynamically with chained methods that correspond
-    # with parts of URNs found at the location.
-    class << self
-      private :new
-    end
-
-    # Sets or returns the request headers for an HttpMagic based class. The
-    # headers will be passed along to each resource request being made.
-    #
-    # == Example
-    #
-    #   class ExampleApi < HttpMagic:Api
-    #     url 'www.example.com'
-    #     headers({'X-AuthToken' => 'token'})
-    #   end
-    def self.headers(value = :not_provided)
-      unless value == :not_provided
-        @headers = value
-      end
-      @headers
-    end
-
-    # Sets or returns the namespace for an HttpMagic based class. The namespace
-    # will be prefixed to the urn for each request made to the url.
-    #
-    # Assuming an api where each resource is namespaced with 'api/v1' and where
-    # the url http://www.example.com/api/v1/foo/99 responds with the following.
-    #
-    # Header:
-    #
-    #   Content-Type: application/json
-    #
-    # Body:
-    #
-    #   {
-    #     "name": "Foo Bar"
-    #   }
-    #
-    # == Example
-    #
-    #   class ExampleApi < HttpMagic:Api
-    #     url 'www.example.com'
-    #     namespace 'api/v1'
-    #   end
-    #
-    #   ExampleApi.foo[99].get['name']
-    #   => "Foo Bar"
-    #
-    def self.namespace(value = :not_provided)
-      unless value == :not_provided
-        @namespace = value
-      end
-      @namespace
-    end
-
-    # Sets or returns the uniform resource locator for the HTTP resource.
-    #
-    # == Example
-    #
-    #   class ExampleApi < HttpMagic::Api
-    #     url 'www.example.com'
-    #   end
-    def self.url(value = :not_provided)
-      unless value == :not_provided
-        @url = value
-      end
-      @url
-    end
-
-    # Class scoped method_missing that starts the magic of creating urns
-    # through meta programming by instantiating an instance of the class
-    # and delegating the first part of the urn to that instance. This method
-    # is an implementation of the Factory Method design pattern.
-    def self.method_missing(name, *args, &block)
-      new(@url, @namespace, @headers).__send__(name, *args)
-    end
-
-    def initialize(url, namespace, headers)
-      @uri = Uri.new(url)
-      @uri.namespace = namespace
-      @headers = headers
-    end
-
-    # Resource index reference intended to allow for the use of numbers in a urn
-    # such as the following 'foo/99' being referenced by ExampleApi.foo[99].  It
-    # can also be used to allow for HttpMagic methods to be specified for a urn
-    # such as 'foo/get' being referenced by ExampleApi.foo[:get]. Finally, it can
-    # be used for urn parts that are not valid Ruby methods such as 'foo/%5B%5D'
-    # being referenced by ExampleApi.foo["%5B%5D"].
-    #
-    # * part - a part of a urn such that 'foo' and 'bar' would be parts of the urn
-    #   'foo/bar'.
-    #
-    # Returns a reference to its instance so that urn parts can be chained
-    # together.
-    def [](part)
-      @uri.parts << part.to_s
-      self
-    end
-
-    def delete
-      request = Request.new(@uri,
-        headers: @headers
-      )
-      request.delete
-    end
-
-    # Gets a resource from the URI and returns it based on its content type.
-    # JSON content will be parsed and returned as equivalent Ruby objects. All
-    # other content types will be returned as text.
-    #
-    # Assuming an api where each resource is namespaced with 'api/v1' and where
-    # the url http://www.example.com/api/v1/foo/99 responds with the following.
-    #
-    # Header:
-    #
-    #   Content-Type: application/json
-    #
-    # Body:
-    #
-    #   {
-    #     "name": "Foo Bar"
-    #   }
-    #
-    # == Example
-    #
-    #   class ExampleApi < HttpMagic::Api
-    #     url 'www.example.com'
-    #     namespace 'api/v1'
-    #   end
-    #
-    #   ExampleApi.foo[99].get
-    #   => { "name" => "Foo Bar" }
-    def get
-      request = Request.new(@uri,
-        headers: @headers
-      )
-      request.get
-    end
-
-    # POST's a resource from the URI and returns the result based on its content
-    # type. JSON content will be parsed and returned as equivalent Ruby objects.
-    # All other content types will be returned as text.
-    #
-    # Assuming an api where each resource is namespaced with 'api/v1' and where
-    # the url http://www.example.com/api/v1/foo/create responds with the
-    # following when a 'name' is sent with the request.
-    #
-    # Header:
-    #
-    #   Content-Type: application/json
-    #
-    # Body:
-    #
-    #   {
-    #     "name": "New Foo"
-    #   }
-    #
-    # == Example
-    #
-    #   class ExampleApi < HttpMagic::Api
-    #     url 'www.example.com'
-    #     namespace 'api/v1'
-    #   end
-    #
-    #   ExampleApi.foo.create.post(name: 'New Foo')
-    #   => { "name" => "New Foo" }
-    def post(data = {})
-      request = Request.new(@uri,
-        headers: @headers,
-        data: data,
-      )
-      request.post
-    end
-
-    def put(data = {})
-      request = Request.new(@uri,
-        headers: @headers,
-        data: data,
-      )
-      request.put
-    end
-
-    # Instance scoped method_missing that accumulates the URN parts used in
-    # forming the URI. It returns a reference to the current instance so that
-    # method and [] based parts can be chained together to from the URN. In the
-    # case of ExampleApi.foo[99] the 'foo' method is accumlated as a URN part
-    # that will form the resulting URI.
-    def method_missing(part, *args, &block)
-      @uri.parts << part.to_s
-      self
-    end
-  end
-end

data/lib/http_magic/request.rb

@@ -1,93 +0,0 @@
-require 'net/http'
-require 'json'
-
-module HttpMagic
-  # Encapsulating class to hold all of the infrastructure to make the actual
-  # requests to the api. It receives at a minimum a HttpMagic::Uri object which
-  # manages the url building.
-  #
-  # == Example
-  #
-  #   uri_object = HttpMagic::Uri.new('http://example.com')
-  #
-  #   request = Request.new(uri_object)
-  #
-  #   request.get
-  #   => { 'name' => 'Foo Bar' }
-  class Request
-    def initialize(uri, options = {})
-      @uri = uri
-      @data = options[:data]
-      @options = {
-        headers: options[:headers] || {}
-      }
-    end
-
-    def delete
-      parse_response http.delete(@uri.urn, @options[:headers])
-    end
-
-    # Makes a GET request to the url provided by the Uri object and returns the
-    # resulting JSON data as a Ruby hash.
-    #
-    # == Example
-    #
-    #   uri_object = HttpMagic::Uri.new('http://example.com')
-    #
-    #   request = Request.new(uri_object)
-    #
-    #   request.get
-    #   => { 'name' => 'Foo Bar' }
-    def get
-      parse_response http.request_get(@uri.urn, @options[:headers])
-    end
-
-    # Makes a POST request to the url provided by the Uri object and returns the
-    # resulting JSON data as a Ruby hash. If data was provided as an optional
-    # initialization parameter, then that is also POSTed.
-    #
-    # == Example
-    #
-    #   uri_object = HttpMagic::Uri.new('http://example.com')
-    #
-    #   request = Request.new(uri_object, data: { name: 'New Foo' })
-    #
-    #   request.post
-    def post
-      if !@data.empty?
-        @options[:headers].merge!( 'Content-Type' => 'application/json' )
-      end
-
-      parse_response http.request_post(@uri.urn, @data.to_json, @options[:headers])
-    end
-
-    def put
-      if !@data.empty?
-        @options[:headers].merge!( 'Content-Type' => 'application/json' )
-      end
-
-      parse_response http.request_put(@uri.urn, @data.to_json, @options[:headers])
-    end
-
-    private
-
-    def http
-      return @http unless @http.nil?
-      @http = Net::HTTP.new(@uri.domain, 443)
-      @http.use_ssl = true
-      @http
-    end
-
-    def parse_response(response)
-      if response && response.is_a?(Net::HTTPSuccess)
-        if response.body && response.content_type == 'application/json'
-          JSON.parse(response.body)
-        else
-          response.body.to_s
-        end
-      else
-        nil
-      end
-    end
-  end
-end

data/lib/http_magic/uri.rb

@@ -1,74 +0,0 @@
-
-module HttpMagic
-  # Helper class that holds the parts of the URI and provides methods to put
-  # them together.
-  #
-  # == Example
-  #
-  #   uri = HttpMagic::Uri.new('example.com')
-  #   uri.build
-  #   => "https://example.com/"
-  #
-  #   uri.namespace = 'api/v2'
-  #   uri.build
-  #   => "https://example.com/api/v2"
-  #
-  #   uri.parts = ['path']
-  #   uri.build
-  #   => "https://example.com/api/v2/path"
-  #
-  class Uri
-    attr_accessor :namespace, :parts
-
-    attr_reader :domain
-
-    def initialize(domain)
-      @domain = domain
-      @parts = []
-    end
-
-    # Builds a full uniform resource identifier.
-    #
-    # == Example
-    #
-    #   uri = HttpMagic::Uri.new('example.com')
-    #   uri.namespace = 'api/v1'
-    #   uri.parts = %w(foo bar)
-    #
-    #   uri.urn
-    #   => "https://example.com/api/v1/foo/bar"
-    def build
-      "#{url}#{urn}"
-    end
-
-    # Uniform resource locator based on @domain value.
-    #
-    # == Example
-    #
-    #   uri = HttpMagic::Uri.new('example.com')
-    #
-    #   uri.url
-    #   => "https://example.com/"
-    #
-    #   uri.url(false)
-    #   => "https://example.com"
-    def url
-      "https://#{@domain}"
-    end
-
-    # Uniform resource name for a resource.
-    #
-    # == Example
-    #
-    #   uri = HttpMagic::Uri.new('example.com')
-    #   uri.namespace = 'api/v1'
-    #   uri.parts = %w(foo bar)
-    #
-    #   uri.urn
-    #   => "/api/v1/foo/bar"
-    def urn
-      resource_name = [@namespace, @parts].flatten.compact.join('/')
-      "/#{resource_name}"
-    end
-  end
-end

data/test/http_magic/api/get_test.rb

@@ -1,68 +0,0 @@
-require 'test_helper'
-require 'http_magic'
-
-class HttpMagicTest < HttpMagic::Api
-end
-
-describe 'HttpMagic#get' do
-  before do
-    @url = HttpMagicTest.url 'www.example.com'
-    HttpMagicTest.namespace nil
-    HttpMagicTest.headers nil
-  end
-
-  it 'should return the root response' do
-    stub_request(:get, "https://#{@url}:443").
-      to_return(body: 'I am root!!')
-
-    assert_equal(
-      'I am root!!',
-      HttpMagicTest.get
-    )
-  end
-
-  it 'should return the named resource' do
-    stub_request(:get, "https://#{@url}:443/bar").
-      to_return(body: 'A bear walked into a bar...')
-
-    assert_equal(
-      'A bear walked into a bar...',
-      HttpMagicTest.bar.get
-    )
-  end
-
-  it 'should return the named resource' do
-    stub_request(:get,  "https://#{@url}:443/bar/84").
-      to_return(body: 'Where Everybody Knows Your Name')
-
-    assert_equal(
-      'Where Everybody Knows Your Name',
-      HttpMagicTest.bar[84].get
-    )
-  end
-
-  it 'should serialize JSON objects' do
-    stub_request(:get,  "https://#{@url}:443/bar/99").
-      to_return(
-        headers: { 'Content-Type' => 'application/json' },
-        body: fixture_file('projects.json')
-      )
-
-    assert_equal(
-      'GradesFirst',
-      HttpMagicTest.bar[99].get.first['name']
-    )
-  end
-
-  it 'should provide specified headers' do
-    stub_request(:get,  "https://#{@url}:443/bar/84").
-      with(headers: { 'X-AuthToken' => 'test_token' }).
-      to_return(body: 'Where Everybody Knows Your Name')
-
-    HttpMagicTest.headers({ 'X-AuthToken' => 'test_token' })
-    assert_equal(
-      'Where Everybody Knows Your Name',
-      HttpMagicTest.bar[84].get
-    )
-  end
-end

data/test/http_magic/api/post_test.rb

@@ -1,34 +0,0 @@
-require 'test_helper'
-require 'http_magic'
-
-class HttpMagicTest < HttpMagic::Api
-end
-
-describe 'HttpMagic#post' do
-  before do
-    @url = HttpMagicTest.url 'www.example.com'
-    HttpMagicTest.namespace nil
-    HttpMagicTest.headers nil
-  end
-
-  it 'should send POST request' do
-    stub_post = stub_request(:post, "https://#{@url}")
-
-    HttpMagicTest.post
-    assert_requested stub_post
-  end
-
-  it 'should send data with POST request' do
-    expected_data = {
-      apple: 'sauce',
-      banana: 'bread'
-    }
-    stub_post = stub_request(:post, "https://#{@url}/foo").with(
-      body: expected_data
-    )
-
-    HttpMagicTest.foo.post(expected_data)
-
-    assert_requested stub_post
-  end
-end

data/test/http_magic/request_test.rb

@@ -1,63 +0,0 @@
-require 'test_helper'
-require 'http_magic/uri'
-require 'http_magic/request'
-
-describe 'HttpMagic::Request' do
-  before do
-    @domain = 'example.com'
-    @uri = HttpMagic::Uri.new(@domain)
-  end
-
-  it 'should make a request' do
-    stub_request = stub_request(
-      :get,
-      "https://#{@domain}/api/v2/path/to/something"
-    )
-
-    @uri.namespace = 'api/v2'
-    @uri.parts = ['path', 'to', 'something']
-    request = HttpMagic::Request.new(@uri)
-    request.get
-
-    assert_requested stub_request
-  end
-
-  it 'should return content on request' do
-    content = 'This is SPARTA!'
-    stub_request(:get, "https://#{@domain}").
-      to_return(body: content)
-
-    request = HttpMagic::Request.new(@uri)
-
-    assert_equal content, request.get
-  end
-
-  it 'should be able to post data as hash' do
-    expected_data = {
-      apple: 'crispy',
-      banana: 'soft'
-    }
-    stub_request = stub_request(:post, "https://#{@domain}").with(
-      body: expected_data.to_json,
-      headers: { 'content-type' => 'application/json' }
-    )
-
-    request = HttpMagic::Request.new(@uri, data: expected_data)
-    request.post
-
-    assert_requested stub_request
-  end
-
-  it 'should set correct headers' do
-    stub_request = stub_request(:get,  "https://#{@domain}").
-      with(headers: { 'X-AuthToken' => 'test_token' })
-
-    request = HttpMagic::Request.new(
-      @uri,
-      headers: { 'X-AuthToken' => 'test_token' }
-    )
-    request.get
-
-    assert_requested stub_request
-  end
-end

data/test/http_magic/uri_test.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-require 'http_magic/uri'
-
-describe 'HttpMagic::Uri' do
-  before do
-    @domain = 'example.com'
-    @uri = uri = HttpMagic::Uri.new(@domain)
-  end
-
-  it 'must have a domain param' do
-    assert_raises ArgumentError do
-      HttpMagic::Uri.new
-    end
-  end
-
-  it 'should return the domain' do
-    assert_equal @domain, @uri.domain
-  end
-
-  it 'can build a simple uri' do
-    assert_equal "https://#{@domain}/", @uri.build
-  end
-
-  it 'should have url' do
-    assert_equal "https://#{@domain}", @uri.url
-  end
-
-  it 'should create urn with parts' do
-    @uri.parts = ['path', 'to', 'something']
-    assert_equal '/path/to/something', @uri.urn
-  end
-
-  it 'should create urn with namespace' do
-    @uri.namespace = 'api/v2'
-    assert_equal '/api/v2', @uri.urn
-  end
-
-  it 'should create urn with namespace and parts combined' do
-    @uri.parts = ['path', 'to', 'something']
-    @uri.namespace = 'api/v2'
-    assert_equal '/api/v2/path/to/something', @uri.urn
-  end
-
-  it 'should create the full uri with urn included' do
-    @uri.parts = ['path', 'to', 'something']
-    @uri.namespace = 'api/v2'
-    assert_equal "https://#{@domain}/api/v2/path/to/something", @uri.build
-  end
-end