octonore 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2a77f05a337906a4f02bdb8980953c05f488aa
-  data.tar.gz: 09cb7615f610c19e264e2f396fcd01c970ce8454
+  metadata.gz: 07233694c096c366e80590fcdf3f1b1f939eb635
+  data.tar.gz: 7b77b9903b047452ec932f2002672341497470db
 SHA512:
-  metadata.gz: 0daa7a05c87557fa64ba1e8b61be8adfaa9c0330d4536453a5cb3938383291cbc0c0b1b12c46200dec2970b88224b35fc86513e546ff3dce549f3ac73ac9ed11
-  data.tar.gz: 2771e998fbc5949d4856661afe7ae3cbbc60c8b46f999ab36d66a766e38fb3d44045624e1822495a5731020bda2d16740a6b8da0b304ee48cf7cd26c1a3c5b4a
+  metadata.gz: 5e0f37b5874a1205f734eb1dfe55ff0e8481f4ca627b9afdf3b72b969cfc9fb9ecacffde7db991fd1b7777b9dc4e95498c816aeaa685551d1ad0fa6194dd73a7
+  data.tar.gz: 019e9604fd33ecba86a11f757ccbb64e0dbb72bfe6c0bdd8e2bd5b3998800255ffb5c5577489f55877bb3a9a767ad70ac0c30ad3d4a898ce59f3cfc9aa7fdae5

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock
 
 # YARD artifacts
 .yardoc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -1,10 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'httparty'
+gem 'httparty', '~> 0.11.0'
 
 group :test do
-  gem 'rspec'
-  gem 'webmock'
-  gem 'vcr'
-  gem 'rake'
+  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

data/README.md

@@ -1,9 +1,9 @@
-Octonore
+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/).
 
-    $ gem install octonore
+	$ gem install octonore
 
 
 Usage
@@ -11,10 +11,46 @@ Usage
 
 To get a gitignore template you first need to instantiate it.
 
-    >> c_template = Octonore::Template.new('C')
-    => #<Octonore::Template:0x007fe5f401a1d0 @name="C">
+	>> c_template = Octonore::Template.new('C')
+    => #<Octonore::Template:0x007fe65b8b2420 @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">
 
-To get a hash of its name and source code, call its `data` method.
+To get the template's source code, you can call its `source` accessor.
 
-    >> c_template.data
-    => #<HTTParty::Response:0x7fe5f50adad8 parsed_response={"name"=>"C", "source"=>"# Object fi…
+	>> c_template.source
+	=> "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Wi
+    ndows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app
+    \n"
+
+
+You can also get the template's name with the `name` accessor.
+
+    >> c_template.name
+    => "C"
+
+You can reload the template's source from Github with the `update` method.
+
+    >> c_template.update
+	=> "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Wi
+    ndows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app
+    \n"
+
+
+### Example Program
+
+The following program asks the user for the name of a gitignore template. It then writes the gitignore to a file ending in `.gitignore`. If the user enters `Java`, then it will write the Java gitignore template to `java.gitignore` in the current directory.
+
+```ruby
+require 'octonore'
+
+begin
+  print "Enter the name of a gitignore template (case sensitive): "
+  template = Octonore::Template.new(gets.strip)
+  
+  File.open("#{template.name.downcase}.gitignore", 'w') { |file|
+          file.write(template.source) }
+rescue GitignoreTemplateNotFoundError => e
+  puts e.message
+end
+```

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/octonore/template.rb

@@ -3,7 +3,7 @@ module Octonore
   # A gitignore template. Templates consist of a name and source.
   class Template
 
-    attr_accessor :name
+    attr_accessor :name, :source
 
     include HTTParty
 
@@ -11,7 +11,7 @@ module Octonore
 
     base_uri 'https://api.github.com/gitignore'
 
-    # Create a new template!
+    # Create a new template.
     #
     # Example:
     #   c_template = Octonore::Template.new('C')
@@ -22,21 +22,20 @@ module Octonore
     
     def initialize(name)
       self.name = name
+      update
     end
 
-    # Get a Hash of the template's name and source.
-    #
-    # Example:
-    #   >> c_template.data["name"]
-    #   => C
-    #
-    #   >> c_template.data["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
-
-    def data(force = false)
-      force ? @data = get_data : @data ||= get_data
+    # Update the Gitignore source from Github.
+
+    def update
+      data = get_data
+      
+      if valid_template_hash? data
+        @source = data["source"]
+      else
+        raise GitignoreTemplateNotFoundError,
+          "Template '#{@name}' does not exist!"
+      end
     end
 
 
@@ -46,10 +45,17 @@ module Octonore
       self.class.get "/templates/#{self.name}", headers: headers 
     end
 
+    def valid_template_hash?(template_hash)
+      template_hash["message"] != "Not Found"
+    end
+
     def headers
       {"User-Agent" => USER_AGENT}
     end
 
   end
 
+  class GitignoreTemplateNotFoundError < StandardError
+  end
+
 end

data/octonore.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = 'octonore'
-  s.version     = '0.0.2'
+  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.summary     = 'Wrapper around the Github gitignore template API.'
+  s.description = 'An octolicious wrapper around the Github gitignore template
+                   API.'
   s.license     = 'MIT'
 
-  s.authors  = ["Zach Latta"]
+  s.authors  = ['Zach Latta']
   s.email    = 'zchlatta@gmail.com'
   s.homepage = 'http://rubygems.org/gems/octonore'
 
@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f|
                       File.basename(f)
                     }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 end

data/spec/fixtures/octonore_cassettes/template.yml

@@ -2,31 +2,56 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.github.com/gitignore/gitignore/templates/C
+    uri: https://api.github.com/gitignore/templates/C
     body:
       encoding: US-ASCII
       string: ''
-    headers: {}
+    headers:
+      User-Agent:
+      - octocore/0.11.0
   response:
     status:
-      code: 403
-      message: Forbidden
+      code: 200
+      message: OK
     headers:
       Server:
       - GitHub.com
       Date:
-      - Thu, 23 May 2013 08:52:40 GMT
+      - Fri, 24 May 2013 01:15:28 GMT
       Content-Type:
-      - application/octet-stream
-      Content-Length:
-      - '107'
+      - application/json; charset=utf-8
       Connection:
       - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '49'
+      X-Github-Media-Type:
+      - github.beta; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '180'
+      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:
+      - '"547a43504d718cb7bc42ed51aae7f643"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
     body:
       encoding: UTF-8
-      string: '{"message":"Missing or invalid User Agent string. See http://developer.github.com/v3/#user-agent-required"}'
+      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: Thu, 23 May 2013 08:52:40 GMT
+  recorded_at: Fri, 24 May 2013 01:15:29 GMT
 - request:
     method: get
     uri: https://api.github.com/gitignore/templates/C
@@ -44,7 +69,7 @@ http_interactions:
       Server:
       - GitHub.com
       Date:
-      - Thu, 23 May 2013 08:52:40 GMT
+      - Fri, 24 May 2013 01:15:29 GMT
       Content-Type:
       - application/json; charset=utf-8
       Connection:
@@ -54,7 +79,7 @@ http_interactions:
       X-Ratelimit-Limit:
       - '60'
       X-Ratelimit-Remaining:
-      - '51'
+      - '48'
       X-Github-Media-Type:
       - github.beta; format=json
       X-Content-Type-Options:
@@ -78,5 +103,50 @@ 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: Thu, 23 May 2013 08:52:40 GMT
+  recorded_at: Fri, 24 May 2013 01:15:29 GMT
+- request:
+    method: get
+    uri: https://api.github.com/gitignore/templates/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - octocore/0.11.0
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Fri, 24 May 2013 01:15:29 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 404 Not Found
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '47'
+      X-Github-Media-Type:
+      - github.beta; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '23'
+      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:
+      - '*'
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version: 
+  recorded_at: Fri, 24 May 2013 01:15:29 GMT
 recorded_with: VCR 2.5.0

data/spec/lib/octonore/template_spec.rb

@@ -18,10 +18,18 @@ describe Octonore::Template do
 
     let(:template) { Octonore::Template.new('C') }
 
+    before { VCR.insert_cassette 'template', :record => :new_episodes }
+
+    after { VCR.eject_cassette }
+
     it "should have a name attribute" do
       template.should respond_to :name
     end
 
+    it "should have a source attribute" do
+      template.should respond_to :source
+    end
+
     it "should have the right name" do
       template.name.should eq('C')
     end
@@ -36,35 +44,21 @@ describe Octonore::Template do
 
     after { VCR.eject_cassette }
 
-    it "should have a data method" do
-      template.should respond_to :data
+    it "should have an update method" do
+      template.should respond_to :update
     end
 
-    it "should parse the api response from JSON to Hash" do
-      template.data.should be_instance_of Hash
+    it "should be able to refresh data from Github" do
+      template.source = nil
+      template.update
+      template.source.should_not equal nil
     end
 
-    it "should get the right data" do
-      template.data["name"].should eq('C')
+    it "should raise an error if template doesn't exist" do
+      expect {
+        bad_template = Octonore::Template.new('invalid') }.to raise_error
     end
     
-    describe "caching" do
-
-      before do
-        template.data
-        stub_request(:any, /api.github.com/).to_timeout
-      end
-
-      it "must cache the data" do
-        template.data.should be_instance_of Hash
-      end
-
-      it "must refresh the data if forced" do
-        lambda { template.data(true) }.should raise_error Timeout::Error
-      end
-
-    end
-
   end
 
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require_relative '../lib/octonore'
 
 require 'webmock/rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octonore
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Zach Latta
@@ -18,9 +18,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,34 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.4)
-    crack (0.3.2)
-    diff-lcs (1.2.4)
-    httparty (0.11.0)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    multi_json (1.7.3)
-    multi_xml (0.5.3)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    vcr (2.5.0)
-    webmock (1.11.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httparty
-  rake
-  rspec
-  vcr
-  webmock