hn_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5025908a7656a4cfda10a23815666e2712251751
+  data.tar.gz: 1586072fdea51f0301be0e27dc840e725a589de4
+SHA512:
+  metadata.gz: 8f91f82695b28dae1492545cbfca6ed5360f306ec357f9a6ce7eaccf0121e0f8c4a9895b1faf84a43cf3137930012446cd074ea10a3248c2cd70f2feb69ceebd
+  data.tar.gz: 2e33ab0387af1851cbfc36f6394e73758821d940366a82ebcea6e4fe4b6379c64b9bc26343228e8032a4e62190774dddaf8a3fb664002ac4419c8eea2e93e7cf

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'faraday',            '>= 0.7', '< 0.10'
+gem 'faraday_middleware', '>= 0.8', '< 0.10'
+gem 'hashie',             '>= 0.4.0'
+
+group :development do
+  gem 'rspec',            '~> 3.0.0'
+  gem 'rdoc',             '~> 3.12'
+  gem 'bundler',          '~> 1.0'
+  gem 'jeweler',          '~> 1.8.7'
+end
+
+group :test do
+  gem 'webmock',          '~> 1.19.0'
+  gem 'coveralls',   require: false
+  gem 'simplecov',   require: false
+  gem 'guard-rspec', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Rahul Horé
+
+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,18 @@
+# hn_api
+
+A Ruby wrapper for [the Hacker News API](https://github.com/HackerNews/API). Currently very alpha.
+
+# Contributing to hn_api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2014 Rahul Horé. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/hn/version'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hn_api"
+  gem.version = HN::Version
+  gem.homepage = "http://github.com/O-I/hn_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the Hacker News API}
+  gem.description = %Q{Ruby client for the Hacker News API}
+  gem.email = "hore.rahul@gmail.com"
+  gem.authors = ["Rahul Horé"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = HN::Version
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hn_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/hn/client.rb

@@ -0,0 +1,27 @@
+require_relative 'request'
+require_relative 'connection'
+require_relative 'configuration'
+
+module HN
+  class Client
+    include HN::Request
+    include HN::Connection
+    include HN::Configuration
+
+    def initialize
+      reset
+    end
+
+    def item(id, options = {})
+      get("item/#{id}.json", options)
+    end
+
+    def user(id, options = {})
+      get("user/#{id}.json", options)
+    end
+
+    def top_stories(options = {})
+      get('topstories.json', options)
+    end
+  end
+end

data/lib/hn/configuration.rb

@@ -0,0 +1,28 @@
+require_relative 'version'
+
+module HN
+  module Configuration
+
+    VALID_CONFIGURATION_KEYS = [:api_version, :base_url, :api_url, :headers]
+
+    attr_accessor *VALID_CONFIGURATION_KEYS
+
+    DEFAULT_VERSION  = 'v0'
+    DEFAULT_BASE_URL = 'https://hacker-news.firebaseio.com'
+    DEFAULT_API_URL  = "#{DEFAULT_BASE_URL}/#{DEFAULT_VERSION}/"
+    DEFAULT_HEADERS  = { accept:     'application/json',
+                         user_agent: "hn_api gem #{HN::Version}" }
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.api_version = DEFAULT_VERSION
+      self.base_url    = DEFAULT_BASE_URL
+      self.api_url     = DEFAULT_API_URL
+      self.headers     = DEFAULT_HEADERS
+      self
+    end
+  end
+end

data/lib/hn/connection.rb

@@ -0,0 +1,24 @@
+require 'faraday_middleware'
+
+module HN
+  module Connection
+
+    private
+
+    def connection
+      options = {
+        headers: headers,
+        ssl:     { verify: false },
+        url:     api_url
+      }
+
+      Faraday.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Response::RaiseError
+        connection.use Faraday::Response::Mashify
+        connection.use Faraday::Response::ParseJson
+        connection.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/hn/request.rb

@@ -0,0 +1,16 @@
+module HN
+  module Request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        request.url(path, options)
+      end
+      response.body
+    end
+  end
+end

data/lib/hn/version.rb

@@ -0,0 +1,14 @@
+module HN
+  class Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    PRE   = nil
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+end

data/lib/hn_api.rb

@@ -0,0 +1,19 @@
+require_relative 'hn/client'
+
+module HN
+  class << self
+
+    def new
+      @client ||= HN::Client.new
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/spec/hn_api_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HnApi" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'hn_api'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: hn_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rahul Horé
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Ruby client for the Hacker News API
+email: hore.rahul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hn/client.rb
+- lib/hn/configuration.rb
+- lib/hn/connection.rb
+- lib/hn/request.rb
+- lib/hn/version.rb
+- lib/hn_api.rb
+- spec/hn_api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/O-I/hn_api
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Hacker News API
+test_files: []