quintype 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b6eaa40ec0c1992393a079355cd4ef4e4a0345f
-  data.tar.gz: 3fd24dbc3782ead2833bfbd7b84d98fbd272cf12
+  metadata.gz: fefb62987388a3665a201c7b5516bb4b16207319
+  data.tar.gz: f2f0d1d2a058b4f884b9fd9848bc836d31022bdb
 SHA512:
-  metadata.gz: 1be78480a44db61e2067c9b3b779df58a7cc4063ccc864ed2f7a93ad6fed41f93b9a5dd472191c39d5320054de1dd917875316e5f13ba6ebb5aece20ed86b5aa
-  data.tar.gz: 4ad1e0588190e7b54929e5d49fe2b3bcc829251736b7dd9332b65574dc8c698f00ca7b0a088b0f2f087a94d46ac055e8e5c5a9f903a6042b745ef624f0d2005b
+  metadata.gz: 6c1d743109ee6717b5d3ba473c93601387d0ff9f3b91085cdef31c81b0f9e8a5eda044b3defd55450b1d278a726c56656c2bf62c358927a51b7eb76e6c70b590
+  data.tar.gz: 676ec05fe4c62ca5a8ac93e1a54de6c9cd721ee1496b514f1c4cb8dd7056d53c843f864a1dcd8853d0eee0a03afa27e2dab138f66ef32f6b14cc3c13dd7f6151

data/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp
+.DS_Store
+.sass-cache/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'rspec', '~> 3.4'
+end
+
+group :development, :test do
+  gem 'pry'
+  gem 'byebug'
+end
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    quintype (0.0.0)
+      activesupport (~> 4.2)
+      faraday (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    byebug (8.2.2)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.4)
+    multipart-post (2.0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (3.0.1)
+    webmock (1.24.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  pry
+  quintype!
+  rspec (~> 3.4)
+  vcr
+  webmock

data/lib/quintype/api.rb

@@ -0,0 +1,224 @@
+require 'faraday'
+require 'json'
+require 'active_support/all'
+
+# API models
+require_relative './api/story'
+require_relative './api/stack'
+require_relative './api/url'
+
+class API
+  class << self
+    def establish_connection(host, conn = Faraday.new(url: host))
+      @@host = host
+      @@api_base = host + '/api/'
+      @@conn = conn
+    end
+
+    def conn
+      @@conn
+    end
+
+    def bulk_post(params)
+      _post("bulk", params)
+    end
+
+    def config
+      _get("config")
+    end
+
+    def story(story_id)
+      _get("stories/#{story_id}")
+    end
+
+    def story_by_slug(slug, params = {})
+      _get("stories-by-slug", params.merge({ slug: slug }))
+    end
+
+    def related_stories(story_id, section, fields = [])
+      _get("related-stories?", {
+             "story-id" => story_id,
+             section: section,
+             fields: make_fields(fields)
+           })
+    end
+
+    def stories(params, options = {})
+      url = options[:facets] ? "stories-with-facets" : "stories"
+      _get(url, params)
+    end
+
+    def comments_and_likes(story_ids)
+      if story_ids.present?
+        _get("comments-and-votes/" + story_ids.join('|'))
+      end
+    end
+
+    def videos
+      _get("stories-by-template", {
+             template: "video",
+             limit: 12,
+             fields: "hero-image-s3-key,hero-image-metadata,hero-image-caption,headline,slug"
+           })
+    end
+
+    def search_story_collection(name, options)
+      _get("story-collection", {
+             name: name,
+             type: "search",
+             fields: "author-name,hero-image-s3-key,hero-image-metadata,hero-image-caption,headline,slug,sections,metadata"
+           }.merge(options))
+    end
+
+    def story_collection(options)
+      _get("story-collection", options)
+    end
+
+    def story_collection_by_tag(options)
+      _get("story-collection/find-by-tag", options)
+    end
+
+    def post_comment(story_content_id, text, parent_comment_id=nil, session_cookie)
+      hash = {
+        "story-content-id"  => story_content_id,
+        "text"              => text
+      }
+      hash.merge!("parent-comment-id" => parent_comment_id.to_i) if parent_comment_id
+      _post("comment", hash, session_cookie)
+    end
+
+    def invite_users(emails, from_email, from_name)
+      params = { emails: emails }
+      params['from-email'] = from_email if from_email.present?
+      params['from-name'] = from_name if from_name.present?
+
+      _post("emails/invite", params)
+    end
+
+    def contact_publisher(params)
+      _post("emails/contact", params)
+    end
+
+    def unsubscribe_publisher(params)
+      _post("emails/unsubscribe", params)
+    end
+
+    def authors(params)
+      _get("authors", params)
+    end
+
+    def author_profile(author_id)
+      _get("author/#{author_id}")
+    end
+
+    def search(options)
+      _get("search", options)
+    end
+
+    def subscribe(member, profile, payment)
+      _post("subscribe", {
+              member: member,
+              profile: profile,
+              payment: payment
+            })
+    end
+
+    def unsubscribe(options)
+      _post("unsubscribe", { options: options })
+    end
+
+    def save_member_metadata(metadata)
+      _post("member/metadata", { metadata: metadata })
+    end
+
+    def check_email(email)
+      _get("member/check", { email: email })
+    end
+
+    def signup_member(member)
+      _post("member", member)
+    end
+
+    def login_member(auth)
+      _post("member/login", auth)
+    end
+
+    def login(provider, data)
+      user, headers = _post_returning_headers("login/#{provider}", data)
+      user['auth_token'] = headers['X-QT-AUTH']
+      user['member'].merge(user.except('member'))
+    end
+
+    def logout
+      _get("logout")
+    end
+
+    def forgot_password(member)
+      _post("member/forgot-password", member)
+    end
+
+    def reset_password(params)
+      _post("member/password", params)
+    end
+
+    def vote_on_story (data)
+      _post("stories/#{data[:story_id]}/votes", data)
+    end
+
+    def votes_on_story (options = {})
+      _get("stories/#{story_id}/votes", options)
+    end
+
+    private
+
+    def _post(url_path, body, session_cookie=nil)
+      body, headers = _post_returning_headers(url_path, body, session_cookie)
+
+      body
+    end
+
+    def _post_returning_headers(url_path, body, session_cookie=nil)
+      response = @@conn.post(@@api_base + url_path) do |request|
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['X-QT-AUTH'] = session_cookie if session_cookie
+
+        request.body = body.to_json
+      end
+
+      if response.body.present?
+        body = case body = JSON.parse(response.body)
+               when Array
+                 body.map { |i| keywordize(i) }
+               when Object
+                 keywordize body
+               end
+
+        [body, response.headers]
+      end
+    end
+
+    def _get(url_path, *args)
+      response = @@conn.get(@@api_base + url_path, *args)
+      return nil if response.status >= 400
+
+      if response.body.present?
+        body = JSON.parse(response.body)
+
+        case body
+        when Array
+          body.map { |i| keywordize(i) }
+        when Object
+          keywordize body
+        end
+      end
+    end
+
+    def keywordize(obj)
+      obj.deep_transform_keys { |k| k.gsub('-', '_') }
+    end
+
+    def make_fields(arr)
+      arr.join(',') if arr.present?
+    end
+  end
+end

data/lib/quintype/api/author.rb

@@ -0,0 +1,42 @@
+class API
+  class Author
+    attr_reader :author
+    class << self
+      def wrap_all(authors)
+        authors ||= []
+        authors.is_a?(Array) ?
+          authors.map { |a| wrap(a) } :
+          wrap(authors)
+      end
+
+      def wrap(author)
+        new(author) if author
+      end
+
+      def where(params)
+        if params['ids'].kind_of? Array
+          params['ids'] = params['ids'].join ","
+        end
+        authors = API.authors(params)
+        wrap_all(authors)
+      end
+
+      def find(params)
+        if authors = API.authors({ids: params}).presence
+          author = authors.first
+          wrap(author)
+        end
+      end
+    end
+
+    def initialize(author)
+      @author = author
+    end
+
+    def to_h(config={})
+      author
+    end
+
+    private
+  end
+end

data/lib/quintype/api/stack.rb

@@ -0,0 +1,18 @@
+class API
+  class Stack
+    class << self
+      def all
+        API.config['layout']['stacks']
+      end
+      #TODO filter by stacks
+      def with_stories(params={}, config={})
+        stories_with_stacks = API::Story.find_by_stacks(all, params)
+        stacks = all.map do |stack|
+          stories = stories_with_stacks[stack['story_group'].gsub('-', '_')]
+          stack['stories'] = stories
+          stack
+        end
+      end
+    end
+  end
+end

data/lib/quintype/api/story.rb

@@ -0,0 +1,119 @@
+require_relative './story/reading_time'
+
+class API
+  class Story
+    attr_reader :story
+    include ReadingTime
+    class << self
+      def wrap_all(stories)
+        stories ||= []
+        stories.is_a?(Array) ?
+          stories.map { |s| wrap(s) } :
+          wrap(stories)
+      end
+
+      def wrap(story)
+        new(story) if story
+      end
+
+      def where(params, opts={})
+        stories = API.stories(params, opts)
+        wrap_all(stories)
+      end
+
+      def find(params, opts={})
+        if stories = API.stories(params, opts).presence
+          story = stories.first
+          wrap(story)
+        end
+      end
+
+      def find_by_stacks(stacks, options={})
+        if stacks.present?
+          requests = stacks.inject({}) do |hash, stack|
+            options.reject! {|k,v| k == 'section' }
+            hash[stack['story_group']] = { 'story_group' => stack['story_group'] }.merge(options)
+            hash
+          end
+
+          stories = find_in_bulk(requests)
+          stories
+        end
+      end
+
+      def find_in_bulk(params)
+        if params.present?
+          params = params.inject({}) do |hash, param|
+            hash[param.first] = param.last.merge(_type: 'stories')
+            hash
+          end
+          response = API.bulk_post(requests: params)
+          response['results']
+        else
+          []
+        end
+      end
+
+      def find_by_slug(slug, params = {})
+        if story = API.story_by_slug(slug, params).presence
+          wrap(story['story'])
+        end
+      end
+
+      def all_video_stories
+        stories = API.videos
+        wrap_all(stories['stories'])
+      end
+
+      def all
+        stories = API.stories({})
+        wrap_all(stories)
+      end
+    end
+
+    def initialize(story)
+      @story = story
+    end
+
+    def cards
+      @cards = story['cards'] || []
+    end
+
+    def to_h(config={})
+      hash = story.merge({
+        'url' => URL.story(story),
+        'time_in_minutes' => time_in_minutes,
+        'tags' => add_urls_to_tags
+      })
+      if config.present?
+        hash.merge!({ 'sections' => add_display_names_to_sections(config),
+                      'canonical_url' => URL.story_canonical(config['root_url'], story)
+                    })
+      end
+      hash
+    end
+
+    private
+    def add_display_names_to_sections(config)
+      return story unless story['sections'].present?
+
+      sections = story['sections'].map do |section|
+        display_section = config['sections'].find { |s| s['id'] == section['id'] } || {}
+
+        display_name = display_section['display_name'] || display_section['name'] || section['name']
+
+        section.merge({ 'display_name' => display_name })
+      end
+    end
+
+    def add_urls_to_tags
+      if story['tags'].present?
+        tags = story['tags'].map do |tag|
+          tag.merge('url' => URL.topic(tag['name']))
+        end
+      else
+        story['tags']
+      end
+    end
+  end
+end