octonore 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07233694c096c366e80590fcdf3f1b1f939eb635
-  data.tar.gz: 7b77b9903b047452ec932f2002672341497470db
+  metadata.gz: 857448e04e2caf963fc6306c6801dbb635c79349
+  data.tar.gz: abcc6c6503efb8ff2e8c883224dbb73cfd212139
 SHA512:
-  metadata.gz: 5e0f37b5874a1205f734eb1dfe55ff0e8481f4ca627b9afdf3b72b969cfc9fb9ecacffde7db991fd1b7777b9dc4e95498c816aeaa685551d1ad0fa6194dd73a7
-  data.tar.gz: 019e9604fd33ecba86a11f757ccbb64e0dbb72bfe6c0bdd8e2bd5b3998800255ffb5c5577489f55877bb3a9a767ad70ac0c30ad3d4a898ce59f3cfc9aa7fdae5
+  metadata.gz: 54ba7afc989cc26b0d93088eeedc398e159dc6d683add35fde6f7168c4bfe4532e98df360a8d83b6aac4cd773c25311cda90f3a0982be6b64d707dcd3104941c
+  data.tar.gz: 769883d03b56feb349670202e44f689c1f28ff62292186e5a56dac9935b558c08f2183d59c21980207a5d085f7835732a15f896b90a38e4c271364dcda0d3dda

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+CHANGELOG
+=========
+
+1.0.0
+-----
+
+Initial feature set:
+
+* List available gitignore templates.
+* Get gitignore templates from Github.

data/Gemfile

@@ -1,11 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'httparty', '~> 0.11.0'
-
-group :test do
+group :development, :test do
   gem "rspec",     "~> 2.13.0"
   gem "webmock",   "~> 1.11.0"
   gem "vcr",       "~> 2.5.0"
   gem "rake",      "~> 10.0.4"
   gem "coveralls", "~> 0.6.7", require: false
 end
+
+gemspec

data/README.md

@@ -1,7 +1,7 @@
 Octonore [![Build Status](https://travis-ci.org/zachlatta/octonore.png?branch=master)](https://travis-ci.org/zachlatta/octonore) [![Code Climate](https://codeclimate.com/github/zachlatta/octonore.png)](https://codeclimate.com/github/zachlatta/octonore) [![Coverage Status](https://coveralls.io/repos/zachlatta/octonore/badge.png?branch=master)](https://coveralls.io/r/zachlatta/octonore?branch=master) [![Dependency Status](https://gemnasium.com/zachlatta/octonore.png)](https://gemnasium.com/zachlatta/octonore)
 ========
 
-An octolicious wrapper around the [Gitignore templates API](http://developer.github.com/v3/gitignore/).
+An octolicious wrapper around the [Gitignore Templates API](http://developer.github.com/v3/gitignore/).
 
 	$ gem install octonore
 
@@ -9,6 +9,12 @@ An octolicious wrapper around the [Gitignore templates API](http://developer.git
 Usage
 -----
 
+List the available templates by calling `Template`'s list method.
+
+    >> Octonore::Template.list
+    => ["Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "
+    C", "C++", "CFWheels", "CMake", "CSharp", "CakePHP", "Clojure", "CodeIgniter...
+
 To get a gitignore template you first need to instantiate it.
 
 	>> c_template = Octonore::Template.new('C')

data/lib/octonore/error.rb

@@ -0,0 +1,7 @@
+module Octonore
+  
+  # Raised when Github returns JSON containing "Not Found" when requesting
+  # a Gitignore template.
+  class GitignoreTemplateNotFoundError < StandardError; end
+
+end

data/lib/octonore/http_helper.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module Octonore
+
+  class HTTPHelper
+    include Singleton
+    include HTTParty
+
+    USER_AGENT = "octonore/#{VERSION}"
+
+    base_uri 'https://api.github.com/gitignore'
+
+    # Get the specified template's hash from Github.
+    # @param location [String] location of resource to get
+    # @return [Hash] whatever is gotten
+    def get(location)
+      self.class.get location, headers: headers 
+    end
+
+    def headers
+      {"User-Agent" => USER_AGENT}
+    end
+    
+  end
+
+end

data/lib/octonore/template.rb

@@ -1,34 +1,59 @@
 module Octonore
 
-  # A gitignore template. Templates consist of a name and source.
+  # A gitignore template. Templates have two attributes: a
+  # name and a source.
   class Template
 
     attr_accessor :name, :source
 
-    include HTTParty
-
-    USER_AGENT = "octocore/#{VERSION}"
-
-    base_uri 'https://api.github.com/gitignore'
+    # List available templates
+    #
+    # Example:
+    #   >> Octonore::Template.list
+    #
+    # @return [Array] The available gitignore templates.
+    def self.list
+      raw_list = Octonore::HTTPHelper.instance.get("/templates")
+      parsed_list = raw_list.parsed_response
+    end
 
     # Create a new template.
     #
     # Example:
     #   c_template = Octonore::Template.new('C')
-    #   java_template = Octonore::Template.new('Java')
+    #   java_template = Octonore::Template.new('java')
     #
-    # Arguments:
-    #   name: (String)
-    
+    # @param name [String] name of template to create
+    # @return [String] Contents of template.
     def initialize(name)
-      self.name = name
-      update
+      # Get two arrays of all of the names of templates available. Downcase
+      # one.
+      list = self.class.list
+      down_list = list.map(&:downcase)
+      # Create a hash from the lowercase names to the normal names so we can
+      # make the user-specified name case-insensitive.
+      list_hash = Hash[down_list.zip(list)]
+
+      # Downcase the the user's name selection and get the matching normal
+      # name in the list_hash
+      self.name = list_hash[name.downcase]
+      # Retrieve the information from Github for their template
+      reload
     end
 
-    # Update the Gitignore source from Github.
-
-    def update
-      data = get_data
+    # Reload the Gitignore source from Github.
+    #
+    # Example:
+    #   >> outdated_template.source = nil
+    #   => nil
+    #   >> outdated_template.reload
+    #   => "# Object files\n*.o\n\n# Libraries\n*.lib..."
+    #   >> outdated_template.source
+    #   => "# Object files\n*.o\n\n# Libraries\n*.lib..."
+    #
+    # @return [String] Contents of template.
+    def reload
+      data = get_template_hash @name
       
       if valid_template_hash? data
         @source = data["source"]
@@ -39,23 +64,27 @@ module Octonore
     end
 
 
-    private
-
-    def get_data
-      self.class.get "/templates/#{self.name}", headers: headers 
-    end
+    protected
 
+    # Verify that the template doesn't contain "Not Found"
+    #
+    # @param [Hash] The template's hash.
+    # @return [Boolean] Whether the template doesn't contain "Not Found"
     def valid_template_hash?(template_hash)
       template_hash["message"] != "Not Found"
     end
 
-    def headers
-      {"User-Agent" => USER_AGENT}
-    end
 
-  end
+    private
+
+    # Get the specified template's hash from Github.
+    # 
+    # @param name [String] name of template to get
+    # @return [Hash] hash containing template info
+    def get_template_hash(name)
+      Octonore::HTTPHelper.instance.get("/templates/#{name}")
+    end
 
-  class GitignoreTemplateNotFoundError < StandardError
   end
 
 end

data/lib/octonore/version.rb

@@ -0,0 +1,5 @@
+module Octonore
+  
+  VERSION = "1.0.0" unless defined?(Octonore::VERSION)
+
+end

data/octonore.gemspec

@@ -1,20 +1,27 @@
-Gem::Specification.new do |s|
-  s.name        = 'octonore'
-  s.version     = '0.0.3'
-  s.date        = '2013-05-23'
-  s.summary     = 'Wrapper around the Github gitignore template API.'
-  s.description = 'An octolicious wrapper around the Github gitignore template
-                   API.'
-  s.license     = 'MIT'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octonore/version'
 
+Gem::Specification.new do |s|
   s.authors  = ['Zach Latta']
   s.email    = 'zchlatta@gmail.com'
   s.homepage = 'http://rubygems.org/gems/octonore'
 
+  s.name        = 'octonore'
+  s.version     = Octonore::VERSION
+  s.date        = '2013-05-30'
+  s.summary     = 'An octolicious wrapper around the Gitignore Templates
+                   API.'
+  s.description = s.summary
+
+  s.license     = 'MIT'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_dependency 'httparty', '~> 0.11.0'
+
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f|
                       File.basename(f)
-                    }
+                  }
   s.require_paths = ['lib']
 end

data/spec/fixtures/octonore_cassettes/template.yml

@@ -1,5 +1,56 @@
 ---
 http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/gitignore/templates
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - octonore/0.11.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 30 May 2013 11:58:28 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '56'
+      X-Github-Media-Type:
+      - github.beta; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '757'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - '*'
+      Etag:
+      - '"75313e55112eb47fac2ff47ea204fd92"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '["Actionscript","Android","AppceleratorTitanium","Autotools","Bancha","C","C++","CFWheels","CMake","CSharp","CakePHP","Clojure","CodeIgniter","Compass","Concrete5","Coq","Delphi","Django","Drupal","Erlang","ExpressionEngine","Finale","ForceDotCom","FuelPHP","GWT","Go","Grails","Haskell","Java","Jboss","Jekyll","Joomla","Jython","Kohana","LaTeX","Leiningen","LemonStand","Lilypond","Lithium","Magento","Maven","Node","OCaml","Objective-C","Opa","OracleForms","Perl","PlayFramework","Python","Qooxdoo","Qt","R","Rails","RhodesRhomobile","Ruby","Scala","Sdcc","SeamGen","SketchUp","SugarCRM","Symfony","Symfony2","SymphonyCMS","Target3001","Tasm","Textpattern","TurboGears2","Unity","VB.Net","Waf","WordPress","Yii","ZendFramework","gcov","nanoc","opencart"]'
+    http_version: 
+  recorded_at: Thu, 30 May 2013 11:58:28 GMT
 - request:
     method: get
     uri: https://api.github.com/gitignore/templates/C
@@ -8,7 +59,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - octocore/0.11.0
+      - octonore/0.11.0
   response:
     status:
       code: 200
@@ -17,7 +68,7 @@ http_interactions:
       Server:
       - GitHub.com
       Date:
-      - Fri, 24 May 2013 01:15:28 GMT
+      - Thu, 30 May 2013 11:58:28 GMT
       Content-Type:
       - application/json; charset=utf-8
       Connection:
@@ -27,7 +78,7 @@ http_interactions:
       X-Ratelimit-Limit:
       - '60'
       X-Ratelimit-Remaining:
-      - '49'
+      - '55'
       X-Github-Media-Type:
       - github.beta; format=json
       X-Content-Type-Options:
@@ -51,7 +102,58 @@ http_interactions:
       string: '{"name":"C","source":"# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n#
         Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"}'
     http_version: 
-  recorded_at: Fri, 24 May 2013 01:15:29 GMT
+  recorded_at: Thu, 30 May 2013 11:58:29 GMT
+- request:
+    method: get
+    uri: https://api.github.com/gitignore/templates/Java
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - octonore/0.11.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 30 May 2013 11:58:29 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '54'
+      X-Github-Media-Type:
+      - github.beta; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '78'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - '*'
+      Etag:
+      - '"881d51421dd39c30283451c1efa37124"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"name":"Java","source":"*.class\n\n# Package Files #\n*.jar\n*.war\n*.ear\n"}'
+    http_version: 
+  recorded_at: Thu, 30 May 2013 11:58:29 GMT
 - request:
     method: get
     uri: https://api.github.com/gitignore/templates/C
@@ -60,7 +162,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - octocore/0.11.0
+      - octonore/0.11.0
   response:
     status:
       code: 200
@@ -69,7 +171,7 @@ http_interactions:
       Server:
       - GitHub.com
       Date:
-      - Fri, 24 May 2013 01:15:29 GMT
+      - Thu, 30 May 2013 11:58:29 GMT
       Content-Type:
       - application/json; charset=utf-8
       Connection:
@@ -79,7 +181,7 @@ http_interactions:
       X-Ratelimit-Limit:
       - '60'
       X-Ratelimit-Remaining:
-      - '48'
+      - '53'
       X-Github-Media-Type:
       - github.beta; format=json
       X-Content-Type-Options:
@@ -103,16 +205,16 @@ http_interactions:
       string: '{"name":"C","source":"# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n#
         Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"}'
     http_version: 
-  recorded_at: Fri, 24 May 2013 01:15:29 GMT
+  recorded_at: Thu, 30 May 2013 11:58:29 GMT
 - request:
     method: get
-    uri: https://api.github.com/gitignore/templates/invalid
+    uri: https://api.github.com/gitignore/templates/
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - octocore/0.11.0
+      - octonore/0.11.0
   response:
     status:
       code: 404
@@ -121,7 +223,7 @@ http_interactions:
       Server:
       - GitHub.com
       Date:
-      - Fri, 24 May 2013 01:15:29 GMT
+      - Thu, 30 May 2013 11:58:29 GMT
       Content-Type:
       - application/json; charset=utf-8
       Connection:
@@ -131,7 +233,7 @@ http_interactions:
       X-Ratelimit-Limit:
       - '60'
       X-Ratelimit-Remaining:
-      - '47'
+      - '52'
       X-Github-Media-Type:
       - github.beta; format=json
       X-Content-Type-Options:
@@ -148,5 +250,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"Not Found"}'
     http_version: 
-  recorded_at: Fri, 24 May 2013 01:15:29 GMT
+  recorded_at: Thu, 30 May 2013 11:58:30 GMT
 recorded_with: VCR 2.5.0

data/spec/lib/octonore/template_spec.rb

@@ -2,18 +2,6 @@ require_relative '../../spec_helper'
 
 describe Octonore::Template do
 
-  describe "default attributes" do
-
-    it "should have httparty methods" do
-      Octonore::Template.should include(HTTParty)
-    end
-
-    it "should have the base url set to the Github API gitignore endpoint" do
-      Octonore::Template.base_uri.should eq('https://api.github.com/gitignore')
-    end
-
-  end
-
   describe "default instance attributes" do
 
     let(:template) { Octonore::Template.new('C') }
@@ -34,6 +22,11 @@ describe Octonore::Template do
       template.name.should eq('C')
     end
 
+    it "should not have case sensitive names" do
+      valid_template = Octonore::Template.new('java')
+      valid_template.name.should eq('Java')
+    end
+
   end
 
   describe "GET template" do
@@ -44,13 +37,13 @@ describe Octonore::Template do
 
     after { VCR.eject_cassette }
 
-    it "should have an update method" do
-      template.should respond_to :update
+    it "should have a reload method" do
+      template.should respond_to :reload
     end
 
-    it "should be able to refresh data from Github" do
+    it "should reload data from Github" do
       template.source = nil
-      template.update
+      template.reload
       template.source.should_not equal nil
     end
 
@@ -58,6 +51,12 @@ describe Octonore::Template do
       expect {
         bad_template = Octonore::Template.new('invalid') }.to raise_error
     end
+
+    it "should list gitignore templates" do
+      templates = Octonore::Template.list      
+      templates.should be_an_instance_of Array
+      templates.should include("C")
+    end
     
   end
 

metadata

@@ -1,18 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: octonore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Zach Latta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
-dependencies: []
-description: |-
-  An octolicious wrapper around the Github gitignore template
-                     API.
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: An octolicious wrapper around the Gitignore Templates API.
 email: zchlatta@gmail.com
 executables: []
 extensions: []
@@ -20,14 +46,18 @@ extra_rdoc_files: []
 files:
 - .coveralls.yml
 - .gitignore
+- .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - lib/octonore.rb
+- lib/octonore/error.rb
+- lib/octonore/http_helper.rb
 - lib/octonore/template.rb
+- lib/octonore/version.rb
 - octonore.gemspec
 - spec/fixtures/octonore_cassettes/template.yml
 - spec/lib/octonore/template_spec.rb
@@ -55,8 +85,9 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Wrapper around the Github gitignore template API.
+summary: An octolicious wrapper around the Gitignore Templates API.
 test_files:
 - spec/fixtures/octonore_cassettes/template.yml
 - spec/lib/octonore/template_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-0.0.3