astronomy_engine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc163ed7ab5163f914ea00c0ddb13c2482714200
+  data.tar.gz: 4fc04e6d5ce1b2344813b5ff08b79af05e1d7831
+SHA512:
+  metadata.gz: 7ef6bc5f0bc57a91dc3047bc70f60819c534980db48d5b6b231851c418642771a39057233051f4a5baa64ee50807619e8c72725d633a95dae418ebfe35858a77
+  data.tar.gz: 983e616f20903f6d807e5352a51a953329d2facd5cdbb0313e8e050f1511d8d8a59d59c418506a431a71d1fd8d9221fc1dea8e3ac10f775e4e146fc7ce0a01b7

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in astronomy_engine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nick Aschenbach
+
+MIT License
+
+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,57 @@
+# AstronomyEngine
+
+A mountable engine for the `astronomy` gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'astronomy_engine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install astronomy_engine
+
+## Usage
+
+Add the mount point for the engine in your rails app:
+
+```ruby
+Rails.application.routes.draw do
+  ...
+  mount AstronomyEngine::App => '/astronomy'
+  ...
+end
+```
+
+Request the list of categories:
+
+```bash
+curl {APPLICATION_ROOT}/astronomy/categories
+```
+
+Request all topics for a given category:
+
+```bash
+curl {APPLICATION_ROOT}/astronomy/categories/Star/topics
+```
+
+Search all topic names and descriptions:
+
+```bash
+curl {APPLICATION_ROOT}/astronomy/topics?q=cluster
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/astronomy_engine/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/astronomy_engine.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'astronomy_engine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'astronomy_engine'
+  spec.version       = AstronomyEngine::VERSION
+  spec.authors       = ['Nick Aschenbach']
+  spec.email         = ['nick.aschenbach@gmail.com']
+  spec.summary       = %q{A light weight, mountable engine for the 'astronomy' gem}
+  spec.description   = %q{A light weight, mountable engine for the 'astronomy' gem. Search or browse various astronomical phenomena}
+  spec.homepage      = 'https://github.com/nick-aschenbach/astronomy-engine'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'capybara', '~> 2.4'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'sinatra', '~> 1.4'
+  spec.add_runtime_dependency 'sinatra-contrib', '~> 1.4'
+  spec.add_runtime_dependency 'astronomy', '~> 0.2'
+end

data/lib/astronomy_engine.rb

@@ -0,0 +1,31 @@
+require 'astronomy_engine/version'
+require 'sinatra'
+require 'astronomy'
+require 'sinatra/json'
+
+module AstronomyEngine
+  class App < Sinatra::Base
+    helpers Sinatra::JSON
+
+    set :astronomy, Astronomy::Information.new
+    before { content_type 'application/json' }
+
+    get '/categories' do
+      json settings.astronomy.categories
+    end
+
+    get '/categories/*/topics' do
+      result = settings.astronomy.topics(params['splat'].first)
+
+      return [404, 'Invalid category'] if result.nil?
+      json result
+    end
+
+    get '/topics' do
+      return [400, 'Must specify a search term `q`'] if params['q'].nil?
+      return [400, 'Please specify a valid value for `q`'] if params['q'].strip.empty?
+
+      json settings.astronomy.search(params['q'].strip)
+    end
+  end
+end

data/lib/astronomy_engine/version.rb

@@ -0,0 +1,3 @@
+module AstronomyEngine
+  VERSION = "0.0.1"
+end

data/spec/astronomy_engine_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe AstronomyEngine::App do
+  include Rack::Test::Methods
+
+  def app
+    AstronomyEngine::App
+  end
+
+  let(:astronomy_instance) { app.new.settings.astronomy }
+
+  let(:sample_topic_data) {
+    [{'name' => 'Brie', 'description' => 'A soft aged creamy spreadable cheese'},
+     {'name' => 'Cheddar', 'description' => 'A yellow, sharp, hard cheese'},
+     {'name' => 'Swiss', 'description' => 'A holey white cheese'}]
+  }
+
+  describe 'application configuration' do
+    it 'sets an instance of Astronomy::Information to astronomy config setting' do
+      expect(astronomy_instance.class).to eq(Astronomy::Information)
+    end
+  end
+
+  describe 'get categories' do
+    it 'delegates the request to the gem' do
+      expect(astronomy_instance).to receive(:categories)
+
+      get '/categories'
+    end
+
+    it 'returns successfully' do
+      get '/categories'
+
+      expect(last_response).to be_ok
+    end
+
+    it 'returns the correct body' do
+      fake_categories = %w[apples pears bananas]
+      allow(astronomy_instance).to receive(:categories).and_return(fake_categories)
+      get '/categories'
+
+      expect(JSON.parse(last_response.body)).to eq(fake_categories)
+    end
+
+    it 'renders the results as json' do
+      get '/categories'
+
+      expect(last_response.header['Content-Type']).to eq('application/json')
+    end
+  end
+
+  describe 'get category topics' do
+    let(:category) { 'cheese' }
+
+    it 'delegates the request to the gem' do
+      expect(astronomy_instance).to receive(:topics).with(category)
+
+      get "/categories/#{category}/topics"
+    end
+
+    context 'when a valid category is passed in' do
+      before do
+        expect(astronomy_instance).to receive(:topics).with(category).and_return(sample_topic_data)
+        get "/categories/#{category}/topics"
+
+      end
+
+      it 'returns successfully' do
+        expect(last_response).to be_ok
+      end
+
+      it 'returns the correct body' do
+        expect(JSON.parse(last_response.body)).to eq(sample_topic_data)
+      end
+
+      it 'returns the correct content type' do
+        expect(last_response.header['Content-Type']).to eq('application/json')
+      end
+    end
+
+    context 'when an invalid category is passed in' do
+      before do
+        allow(astronomy_instance).to receive(:topics).and_return(nil)
+        get "/categories/#{category}/topics"
+      end
+
+      it 'returns a 404' do
+        expect(last_response.status).to eq(404)
+      end
+
+      it 'returns a body with error message' do
+        expect(last_response.body).to eq('Invalid category')
+      end
+    end
+  end
+
+  describe 'search topics' do
+    context 'when the query string parameter is valid' do
+      let(:q) { 'candy' }
+      let(:endpoint_with_query_param) { "/topics?q=#{q}" }
+
+      it 'ignores leading and trailing whitespace' do
+        expect(astronomy_instance).to receive(:search).with('foo')
+
+        get '/topics?q=%20%20%20%20%20%20%20%20%20%20foo%20%20%20%20%20'
+      end
+
+      it 'delegates the request to the gem' do
+        expect(astronomy_instance).to receive(:search).with(q)
+
+        get endpoint_with_query_param
+      end
+
+      it 'returns successfully' do
+        get endpoint_with_query_param
+
+        expect(last_response).to be_ok
+      end
+
+      it 'returns the correct body' do
+        allow(astronomy_instance).to receive(:search).and_return(sample_topic_data)
+
+        get endpoint_with_query_param
+        expect(JSON.parse(last_response.body)).to eq(sample_topic_data)
+      end
+
+      it 'returns the correct content type' do
+        get endpoint_with_query_param
+
+        expect(last_response.header['Content-Type']).to eq('application/json')
+      end
+    end
+
+    context 'when no search term is provided' do
+      before { get '/topics' }
+
+      it 'returns a 400' do
+        expect(last_response.status).to eq(400)
+      end
+
+      it 'returns a body with an error message' do
+        expect(last_response.body).to eq('Must specify a search term `q`')
+      end
+    end
+
+    context 'when it is an empty string' do
+      before { get '/topics?q=' }
+
+      it 'returns a 400' do
+        expect(last_response.status).to eq(400)
+      end
+
+      it 'returns a body with an error message' do
+        expect(last_response.body).to eq('Please specify a valid value for `q`')
+      end
+    end
+
+    context 'when it is just white space' do
+      before { get '/topics?q=%20%20%20' }
+
+      it 'returns a 400' do
+        expect(last_response.status).to eq(400)
+      end
+
+      it 'returns a body with an error message' do
+        expect(last_response.body).to eq('Please specify a valid value for `q`')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'astronomy_engine'
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.include Capybara::DSL
+
+  config.before do
+    Capybara.app = AstronomyEngine::App
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: astronomy_engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Aschenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: astronomy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A light weight, mountable engine for the 'astronomy' gem. Search or browse
+  various astronomical phenomena
+email:
+- nick.aschenbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- astronomy_engine.gemspec
+- lib/astronomy_engine.rb
+- lib/astronomy_engine/version.rb
+- spec/astronomy_engine_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nick-aschenbach/astronomy-engine
+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.5
+signing_key: 
+specification_version: 4
+summary: A light weight, mountable engine for the 'astronomy' gem
+test_files:
+- spec/astronomy_engine_spec.rb
+- spec/spec_helper.rb