rack-newsstand 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6593b8cd8b161d5fb3d31a895e8064de2fab51b2
+  data.tar.gz: d3db244673a496ca0a39a38331ecabaf9a3a5f5e
+SHA512:
+  metadata.gz: 2e92b50f238e90aaabbacbaceafc2da5f3d608345fba365ebb186ebad2322796057188fb77b00d97f8128740058d455a07bb09339c8f256b87f9a6da451f9c37
+  data.tar.gz: 60209b4a09d4b6a37fdcc2aa907401890a6e44e3ae2cce94edc45f3426552ddf4bef6b15415372b466a507e9f6c4f2980d5cd77ce1efc71019937467230f5612

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    rack-newsstand (0.0.3)
+      builder (>= 3.0)
+      plist (~> 3.1)
+      rack (~> 1.4)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.0)
+    diff-lcs (1.2.4)
+    plist (3.1.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    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)
+    sequel (3.47.0)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-newsstand!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Mattt Thompson (http://mattt.me/)
+
+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,92 @@
+# Rack::Newsstand
+
+Newsstand was introduced in iOS 5 to give publishers a common framework to syndicate content. `Rack::Newsstand` provides webservice endpoints for issue data, as well as a Newsstand Atom feed.
+
+## Requirements
+
+- PostgreSQL 9.1 running locally ([Postgres.app](http://postgresapp.com) is the easiest way to get a Postgres server running on your Mac)
+
+## Example Usage
+
+Rack::Newsstand can be run as Rack middleware or as a single web application. All that is required is a connection to a Postgres database.
+
+### Gemfile
+
+```ruby
+source "https://rubygems.org"
+
+gem 'rack-newsstand'
+gem 'pg'
+```
+
+### config.ru
+
+```ruby
+require 'bundler'
+Bundler.require
+
+run Rack::Newsstand
+```
+
+An example application can be found in the `/example` directory of this repository.
+
+### `GET /issues` (`Accept: application/x-plist`)
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <array>
+    <dict>
+      <key>name</key>
+      <string>magazine-1</string>
+      <key>title</key>
+      <string>Magazine Issue 1</string>
+      <key>summary</key>
+      <string>Lorem ipsum dolar sit amet</string>
+      <key>date</key>
+      <date>2013-04-19T12:00:00Z</date>
+      <key>covers</key>
+      <dict>
+        <key>SOURCE</key>
+        <string>http://example.com/assets/covers/magazine-1.png</string>
+      </dict>
+      <key>content</key>
+      <array>
+        <string>http://example.com/assets/content/magazine-1.pdf</string>
+      </array>
+    </dict>
+  </array>
+</plist>
+```
+
+### `GET /issues` (`Accept: application/application/atom+xml`)
+
+```xml
+<?xml version="1.1" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:news="http://itunes.apple.com/2011/Newsstand">
+  <updated>
+  </updated>
+  <entry>
+    <id>magazine-0</id>
+    <summary/>
+    <updated>2013-04-30 09:59:54 -0700</updated>
+    <published>2013-04-30 09:59:54 -0700</published>
+    <news:cover_art_icons>
+      <news:cover_art_icon size="SOURCE" src="http://example.com/assets/covers/magazine-1.png"/>
+    </news:cover_art_icons>
+  </entry>
+</feed>
+```
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::Newsstand is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("rack-newsstand.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-newsstand.gemspec"] do
+  system "gem build rack-newsstand.gemspec"
+end

data/lib/rack/newsstand.rb

@@ -0,0 +1,77 @@
+require 'rack'
+require 'sinatra/base'
+require 'sequel'
+
+module Rack
+  class Newsstand < Sinatra::Base
+    autoload :Issue, 'rack/newsstand/models/issue'
+
+    disable :raise_errors, :show_exceptions
+
+    configure do
+      Sequel.extension :core_extensions, :migration, :pg_array, :pg_hstore, :pg_hstore_ops
+
+      if ENV['DATABASE_URL']
+        DB = Sequel.connect(ENV['DATABASE_URL'])
+        DB.extend Sequel::Postgres::PGArray::DatabaseMethods
+        DB.extend Sequel::Postgres::HStore::DatabaseMethods
+
+        Sequel::Migrator.run(DB, ::File.join(::File.dirname(__FILE__), "newsstand/migrations"), table: 'newsstand_schema_info')
+      end
+    end
+
+    get '/issues' do
+      @issues = Issue.order(:published_at).all
+
+      request.accept.each do |type|
+        case type.to_s
+        when 'application/atom+xml', 'application/xml', 'text/xml'
+          content_type 'application/x-plist'
+          return builder :atom
+        when 'application/x-plist'
+          content_type 'application/x-plist'
+          return @issues.to_plist
+        when 'application/json'
+          pass
+        end
+      end
+
+      halt 406
+    end
+
+    get '/issues/:name' do
+      pass unless request.accept? 'application/x-plist'
+      content_type 'application/x-plist'
+
+      param :name, String, empty: false
+
+      Issue.find(name: params[:name]).to_plist
+    end
+
+    template :atom do
+<<-EOF
+      xml.instruct! :xml, :version => '1.1'
+      xml.feed "xmlns" => "http://www.w3.org/2005/Atom",
+               "xmlns:news" => "http://itunes.apple.com/2011/Newsstand" do
+
+      xml.updated { @issues.first.updated_at rescue Time.now }
+
+      @issues.each do |issue|
+        xml.entry do
+          xml.id issue.name
+          xml.summary issue.summary
+          xml.updated issue.updated_at
+          xml.published issue.published_at
+          xml.tag!("news:end_date"){ issue.expires_at } if issue.expires_at
+          xml.tag!("news:cover_art_icons") do
+            issue.cover_urls.each do |size, url|
+              xml.tag!("news:cover_art_icon", size: size, src: url)
+            end
+          end
+        end
+      end
+    end
+EOF
+    end
+  end
+end

data/lib/rack/newsstand/migrations/001_base_schema.rb

@@ -0,0 +1,28 @@
+Sequel.migration do
+  up do
+    run %{CREATE EXTENSION IF NOT EXISTS hstore;}
+
+    create_table :newsstand_issues do
+      primary_key :id
+
+      column :name,         :varchar, unique: true, empty: false
+      column :title,        :varchar, empty: false
+      column :summary,      :varchar, empty: false
+      column :tags,         :'text[]'
+      column :metadata,     :hstore
+      column :cover_urls,   :hstore
+      column :asset_urls,   :'text[]'
+      column :created_at,   :timestamp
+      column :updated_at,   :timestamp
+      column :published_at, :timestamp
+      column :expires_at,   :timestamp
+
+      index :name
+      index :published_at
+    end
+  end
+
+  down do
+    drop_table :newsstand_issues
+  end
+end

data/lib/rack/newsstand/models/issue.rb

@@ -0,0 +1,34 @@
+require 'plist'
+
+module Rack
+  class Newsstand
+    class Issue < Sequel::Model
+      plugin :json_serializer, naked: true, except: :id
+      plugin :validation_helpers
+      plugin :timestamps, force: true, update_on_create: true
+      plugin :schema
+      plugin :typecast_on_load
+
+      self.dataset = :newsstand_issues
+      self.strict_param_setting = false
+      self.raise_on_save_failure = false
+
+      def to_plist_node
+        {
+          name: self.name,
+          title: self.title,
+          date: self.published_at,
+          covers: self.cover_urls.to_hash,
+          assets: self.asset_urls.to_a
+        }.to_plist(false)
+      end
+
+      def validate
+        super
+
+        validates_presence [:name, :published_at]
+        validates_unique :name
+      end
+    end
+  end
+end

data/rack-newsstand.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rack-newsstand"
+  s.license     = "MIT"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.version     = "0.0.3"
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::Newsstand"
+  s.description = "Automatically generate webservice endpoints for Newsstand"
+
+  s.add_dependency "rack", "~> 1.4"
+  s.add_dependency "sinatra", "~> 1.3"
+  s.add_dependency "sequel", "~> 3.37"
+  s.add_dependency "plist", "~> 3.1"
+  s.add_dependency "builder", ">= 3.0"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rack-newsstand
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.37'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically generate webservice endpoints for Newsstand
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/newsstand/migrations/001_base_schema.rb
+- ./lib/rack/newsstand/models/issue.rb
+- ./lib/rack/newsstand.rb
+- ./LICENSE
+- ./rack-newsstand-0.0.1.gem
+- ./rack-newsstand-0.0.2.gem
+- ./rack-newsstand.gemspec
+- ./Rakefile
+- ./README.md
+homepage: http://mattt.me
+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: Rack::Newsstand
+test_files: []