octonore 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c2a77f05a337906a4f02bdb8980953c05f488aa
+  data.tar.gz: 09cb7615f610c19e264e2f396fcd01c970ce8454
+SHA512:
+  metadata.gz: 0daa7a05c87557fa64ba1e8b61be8adfaa9c0330d4536453a5cb3938383291cbc0c0b1b12c46200dec2970b88224b35fc86513e546ff3dce549f3ac73ac9ed11
+  data.tar.gz: 2771e998fbc5949d4856661afe7ae3cbbc60c8b46f999ab36d66a766e38fb3d44045624e1822495a5731020bda2d16740a6b8da0b304ee48cf7cd26c1a3c5b4a

data/.gitignore

@@ -0,0 +1,22 @@
+############
+#   Ruby   #
+############
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'httparty'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Zachary Latta
+
+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,20 @@
+Octonore
+========
+
+An octolicious wrapper around the [Gitignore templates API](http://developer.github.com/v3/gitignore/).
+
+    $ gem install octonore
+
+
+Usage
+-----
+
+To get a gitignore template you first need to instantiate it.
+
+    >> c_template = Octonore::Template.new('C')
+    => #<Octonore::Template:0x007fe5f401a1d0 @name="C">
+
+To get a hash of its name and source code, call its `data` method.
+
+    >> c_template.data
+    => #<HTTParty::Response:0x7fe5f50adad8 parsed_response={"name"=>"C", "source"=>"# Object fi…

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/octonore.rb

@@ -0,0 +1,5 @@
+require 'httparty'
+
+Dir[File.dirname(__FILE__) + '/octonore/*.rb'].each do |file|
+  require file
+end

data/lib/octonore/template.rb

@@ -0,0 +1,55 @@
+module Octonore
+
+  # A gitignore template. Templates consist of a name and source.
+  class Template
+
+    attr_accessor :name
+
+    include HTTParty
+
+    USER_AGENT = "octocore/#{VERSION}"
+
+    base_uri 'https://api.github.com/gitignore'
+
+    # Create a new template!
+    #
+    # Example:
+    #   c_template = Octonore::Template.new('C')
+    #   java_template = Octonore::Template.new('Java')
+    #
+    # Arguments:
+    #   name: (String)
+    
+    def initialize(name)
+      self.name = name
+    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
+    end
+
+
+    private
+
+    def get_data
+      self.class.get "/templates/#{self.name}", headers: headers 
+    end
+
+    def headers
+      {"User-Agent" => USER_AGENT}
+    end
+
+  end
+
+end

data/octonore.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'octonore'
+  s.version     = '0.0.2'
+  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'
+
+  s.authors  = ["Zach Latta"]
+  s.email    = 'zchlatta@gmail.com'
+  s.homepage = 'http://rubygems.org/gems/octonore'
+
+  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

@@ -0,0 +1,82 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/gitignore/gitignore/templates/C
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 23 May 2013 08:52:40 GMT
+      Content-Type:
+      - application/octet-stream
+      Content-Length:
+      - '107'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Missing or invalid User Agent string. See http://developer.github.com/v3/#user-agent-required"}'
+    http_version: 
+  recorded_at: Thu, 23 May 2013 08:52:40 GMT
+- request:
+    method: get
+    uri: https://api.github.com/gitignore/templates/C
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - octocore/0.11.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 23 May 2013 08:52:40 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '51'
+      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: '{"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_with: VCR 2.5.0

data/spec/lib/octonore/template_spec.rb

@@ -0,0 +1,70 @@
+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') }
+
+    it "should have a name attribute" do
+      template.should respond_to :name
+    end
+
+    it "should have the right name" do
+      template.name.should eq('C')
+    end
+
+  end
+
+  describe "GET template" do
+
+    let(:template) { Octonore::Template.new('C') }
+
+    before { VCR.insert_cassette 'template', :record => :new_episodes }
+
+    after { VCR.eject_cassette }
+
+    it "should have a data method" do
+      template.should respond_to :data
+    end
+
+    it "should parse the api response from JSON to Hash" do
+      template.data.should be_instance_of Hash
+    end
+
+    it "should get the right data" do
+      template.data["name"].should eq('C')
+    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

@@ -0,0 +1,9 @@
+require_relative '../lib/octonore'
+
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/octonore_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: octonore
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+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.
+email: zchlatta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/octonore.rb
+- lib/octonore/template.rb
+- octonore.gemspec
+- spec/fixtures/octonore_cassettes/template.yml
+- spec/lib/octonore/template_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/octonore
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Wrapper around the Github gitignore template API.
+test_files:
+- spec/fixtures/octonore_cassettes/template.yml
+- spec/lib/octonore/template_spec.rb
+- spec/spec_helper.rb