quintype-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cc3aac817c35e6ac9cb03b46bdecf715baee374
+  data.tar.gz: 953311b536e2425d47b3078f403e9ad87f6ad263
+SHA512:
+  metadata.gz: e92ee459a05ae48f44d89a74ce77cb20a85cbf11981dd541a00a1f4bb3faab92f47d268729ea86bd9e7b51b0539af315c2486c67608ab07f0d7f544352c4b49c
+  data.tar.gz: 563a669888533bbcf0e25e90930717e302b7883fa2e561515ed789e026d3259b3d525af2ec27557bfdebc040a2851226f828d658b9b0027929ab31d5012d0fc1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,78 @@
+# Quintype::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/quintype/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quintype-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quintype-api
+
+## Usage
+
+### Establishing Connection
+
+First, you must establish a connection, as follows
+
+```ruby
+Quintype::API::Client.establish_connection("http://sketches.quintype.com", Faraday.default_adapter)
+```
+
+### Subclassing API classes
+
+It is highly recommended that you subclass API sections. This is mostly honored during requests
+
+```ruby
+class QtConfig < Quintype::API::Config
+end
+
+class Story < Quintype::API::Story
+end
+```
+
+### Fetching the Config
+
+```ruby
+QtConfig.get.sections
+```
+
+### Fetching a story by slug
+
+```ruby
+Story.find_by_slug("5-timeless-truths-from-the-serenity-prayer-that-offer-wisdom")
+```
+
+### Bulk Fetching stories
+
+```ruby
+request = Quintype::API::Bulk.new
+request
+  .add_request("entertainment", Story.bulk_stories_request("top").add_params(section: "Entertainment"))
+  .add_request("sports", Story.bulk_stories_request("top").add_params(section: "Sports"))
+  .execute!
+entertainment_stories = request.get_response("entertainment")
+sports_stories = request.get_response("sports")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quintype/quintype-api-ruby.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quintype/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quintype/api/base_functions.rb

@@ -0,0 +1,33 @@
+module Quintype::API
+  module BaseFunctions
+    module ClassFunctions
+      def members_as_string
+        @members_as_string ||= members.map {|i| i.to_s.gsub(/_/, "-")}
+      end
+
+      def from_hash(hash, *args)
+        new *(args + hash.values_at(*members_as_string))
+      end
+
+      def coerce_array(key, clazz)
+        class_eval <<-EOF
+          def #{key.to_s}
+            super.map { |i| #{clazz.name}.from_hash(i)}
+          end
+        EOF
+      end
+
+      def coerce_key(key, clazz)
+        class_eval <<-EOF
+          def #{key.to_s}
+            #{clazz.name}.from_hash(i)
+          end
+        EOF
+      end
+    end
+
+    def self.included(clazz)
+      clazz.extend(ClassFunctions)
+    end
+  end
+end

data/lib/quintype/api/bulk.rb

@@ -0,0 +1,28 @@
+module Quintype::API
+  class Bulk
+    def initialize
+      @requests = {}
+    end
+
+    def add_request(name, request)
+      @requests[name] = request
+      self
+    end
+
+    def execute!
+      requests = @requests.inject({}) do |acc, pair|
+        acc[pair[0]] = pair[1].to_bulk_request
+        acc
+      end
+      response = Client.instance.post_bulk(requests: requests).body
+      @responses = response["results"].inject({}) do |acc, pair|
+        acc[pair[0]] = @requests[pair[0]].from_bulk_response(pair[1])
+        acc
+      end
+    end
+
+    def get_response(name)
+      @responses[name]
+    end
+  end
+end

data/lib/quintype/api/client.rb

@@ -0,0 +1,60 @@
+module Quintype::API
+  class ClientException < Exception
+    attr_reader :response
+
+    def initialize(message, response)
+      super(message)
+      @response = response
+    end
+  end
+
+  class Client
+    class << self
+      def establish_connection(host, adapter = nil)
+        connection = Faraday.new(host) do |conn|
+          conn.request  :json
+          conn.response :json, :content_type => /\bjson$/
+          conn.adapter(adapter || Faraday.default_adapter)
+        end
+        @client = new(connection)
+      end
+
+      def instance
+        @client
+      end
+    end
+
+    def initialize(conn)
+      @conn = conn
+    end
+
+    def get_config
+      get("/api/v1/config")
+    end
+
+    def get_story_by_slug(slug)
+      get("/api/v1/stories-by-slug", slug: slug)
+    end
+
+    def post_bulk(requests)
+      post("/api/v1/bulk", requests)
+    end
+
+    private
+    def get(url, params = {})
+      parse_response @conn.get(url, params)
+    end
+
+    def post(url, body, params = {})
+      parse_response @conn.post(url, body, params)
+    end
+
+    def parse_response(response)
+      if(response.status < 400)
+        response
+      else
+        raise ClientException.new("API returned a non successful response", response)
+      end
+    end
+  end
+end

data/lib/quintype/api/config.rb

@@ -0,0 +1,19 @@
+module Quintype::API
+  class Config < Base(:sketches_host, :sections, :layout, :cdn_name, :publisher_id, :story_slug_format, :cdn_image)
+    class << self
+      def get
+        from_hash(Client.instance.get_config.body)
+      end
+    end
+
+    coerce_array :sections, Section
+
+    def menu_items
+      layout["menu"].map { |i| MenuItem.from_hash(i, self) }
+    end
+
+    def stacks
+      StackCollection.new layout["stacks"].map { |i| Stack.from_hash(i) }
+    end
+  end
+end

data/lib/quintype/api/menu_item.rb

@@ -0,0 +1,9 @@
+module Quintype::API
+  class MenuItem < Base(:id, :item_id, :rank, :title, :item_type, :tag_name, :section_slug, :parent_id, :data)
+
+    def initialize(config, *args)
+      @config = config
+      super(*args)
+    end
+  end
+end

data/lib/quintype/api/section.rb

@@ -0,0 +1,4 @@
+module Quintype::API
+  class Section < Base(:id, :name, :display_name, :slug, :parent_id)
+  end
+end

data/lib/quintype/api/stack.rb

@@ -0,0 +1,4 @@
+module Quintype::API
+  class Stack < Base(:show_on_locations, :background_color, :rank, :story_group, :max_stories, :id, :show_on_all_sections?, :heading)
+  end
+end

data/lib/quintype/api/stack_collection.rb

@@ -0,0 +1,17 @@
+module Quintype::API
+  class StackCollection
+    include Enumerable
+
+    def initialize(stacks)
+      @stacks = stacks
+    end
+
+    def each
+      @stacks.each { |i| yield i }
+    end
+
+    def for_location(location)
+      select { |stack| stack.show_on_all_sections? || stack.show_on_locations.include?(location)}
+    end
+  end
+end

data/lib/quintype/api/story.rb

@@ -0,0 +1,34 @@
+module Quintype::API
+  class StoriesRequest
+    def initialize(klazz, story_group)
+      @klazz = klazz
+      @params = {"story-group" => story_group}
+    end
+
+    def add_params(params)
+      @params.merge!(params)
+      self
+    end
+
+    def to_bulk_request
+      @params.merge(_type: "stories")
+    end
+
+    def from_bulk_response(response)
+      response["stories"].map {|i| @klazz.from_hash(i) }
+    end
+  end
+
+  class Story < Base(:updated_at, :assignee_id, :author_name, :tags, :headline, :storyline_id, :votes, :story_content_id, :slug, :last_published_at, :sections, :content_created_at, :owner_name, :custom_slug, :push_notification, :publisher_id, :hero_image_metadata, :comments, :published_at, :storyline_title, :summary, :autotags, :status, :bullet_type, :id, :hero_image_s3_key, :cards, :story_version_id, :content_updated_at, :author_id, :owner_id, :first_published_at, :hero_image_caption, :version, :story_template, :created_at, :authors, :metadata, :publish_at, :assignee_name)
+
+    class << self
+      def find_by_slug(slug)
+        from_hash(Client.instance.get_story_by_slug(slug).body["story"])
+      end
+
+      def bulk_stories_request(story_group)
+        StoriesRequest.new(self, story_group)
+      end
+    end
+  end
+end

data/lib/quintype/api/version.rb

@@ -0,0 +1,5 @@
+module Quintype
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/lib/quintype/api.rb

@@ -0,0 +1,25 @@
+require "quintype/api/version"
+
+require "faraday"
+require "faraday_middleware"
+
+module Quintype
+  module API
+    autoload :Client,           "quintype/api/client"
+    autoload :BaseFunctions,    "quintype/api/base_functions"
+
+    def self.Base(*args)
+      clazz = Struct.new(*args)
+      clazz.send(:include, BaseFunctions)
+      clazz
+    end
+
+    autoload :Config,           "quintype/api/config"
+    autoload :Section,          "quintype/api/section"
+    autoload :MenuItem,         "quintype/api/menu_item"
+    autoload :Stack,            "quintype/api/stack"
+    autoload :StackCollection,  "quintype/api/stack_collection"
+    autoload :Story,            "quintype/api/story"
+    autoload :Bulk,             "quintype/api/bulk"
+  end
+end

data/quintype-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quintype/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quintype-api"
+  spec.version       = Quintype::Api::VERSION
+  spec.authors       = ["Tejas Dinkar"]
+  spec.email         = ["tejas@gja.in"]
+
+  spec.summary       = %q{Ruby Gem to Access the Quintype API}
+  spec.homepage      = "https://github.com/quintype/quintype-api-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: quintype-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tejas Dinkar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: 
+email:
+- tejas@gja.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quintype/api.rb
+- lib/quintype/api/base_functions.rb
+- lib/quintype/api/bulk.rb
+- lib/quintype/api/client.rb
+- lib/quintype/api/config.rb
+- lib/quintype/api/menu_item.rb
+- lib/quintype/api/section.rb
+- lib/quintype/api/stack.rb
+- lib/quintype/api/stack_collection.rb
+- lib/quintype/api/story.rb
+- lib/quintype/api/version.rb
+- quintype-api.gemspec
+homepage: https://github.com/quintype/quintype-api-ruby
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to Access the Quintype API
+test_files: []