faraday-hypermedia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f63e35dfde4a2d3f6515bf0657d07a1b128610ce
+  data.tar.gz: bb28d0fca41af3d65699dc94dbf5f19febad83f5
+SHA512:
+  metadata.gz: 970c174716e533844369a0f314e8e98bc3ac28be282976a1a36cf5ca285e05b23d0d16fb96bb0c74802ebea0575e1b0a8b9d6a85f8fa32bd9857bb7765aca9a5
+  data.tar.gz: 80ba187fdbe7a6783d9c2bf26916f76f2bdb1901b6f88d07b034e8cf1c6b37149eeb50cae23fbe7330eecf4b920cfa2d45400e9073806014e5e312f99a756b22

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Toru KAWAMURA
+
+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,41 @@
+# Faraday::Hypermedia
+
+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/faraday/hypermedia`. 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 'faraday-hypermedia'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-hypermedia
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/[USERNAME]/faraday-hypermedia.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faraday/hypermedia"
+
+# 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/faraday-hypermedia.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/hypermedia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-hypermedia"
+  spec.version       = Faraday::Hypermedia::VERSION
+  spec.authors       = ["Toru KAWAMURA"]
+  spec.email         = ["tkawa@4bit.net"]
+
+  spec.summary       = %q{Faraday middleware that supports hypermedia client}
+  spec.description   = %q{Faraday middleware that supports hypermedia client}
+  spec.homepage      = "https://github.com/tkawa/faraday-hypermedia"
+  spec.license       = "MIT"
+
+  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.8.0"
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'http_link_header'
+  spec.add_dependency 'faraday_collection_json'
+  spec.add_dependency 'uri_template'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'faraday-detailed_logger'
+  spec.add_development_dependency 'faraday-http-cache'
+end

data/lib/faraday-hypermedia.rb

@@ -0,0 +1 @@
+require 'faraday/hypermedia'

data/lib/faraday/hypermedia.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'faraday/hypermedia/history'
+require 'faraday/hypermedia/link_extractor'
+require 'faraday/hypermedia/navigation'
+require 'faraday/hypermedia/version'
+require_relative '../uri/navigation'
+
+module Faraday
+  module Hypermedia
+    RE_URI_TEMPLATE = /\{.*\}/
+  end
+
+  Middleware.register_middleware navigation: Hypermedia::Navigation
+  Response.register_middleware link_cj: Hypermedia::LinkExtractorCJ
+  Response.register_middleware link_github: Hypermedia::LinkExtractorGithub
+
+end

data/lib/faraday/hypermedia/history.rb

@@ -0,0 +1,120 @@
+require 'http_link_header'
+require 'uri_template'
+
+module Faraday
+  module Hypermedia
+    class History
+      State = Struct.new(:data, :title, :url)
+
+      def initialize
+        @stored_states = [build_state]
+        @current_index = 0
+        reset_current_links
+      end
+
+      def current_state
+        @stored_states[@current_index]
+      end
+
+      # いったんここに実装
+      def current_links
+        @current_links ||= build_current_links
+      end
+
+      def pp_current_links
+        # TODO: きれいにする
+        # current_links.to_a.join("#{current_links.class::DELIMETER}\n")
+        rels = current_links.map{|url, params| params['rel'].to_a.map{|rel| [rel, [url, params]] }}.flatten(1).group_by{|rel, _| rel}
+        rels.each do |rel, links|
+          puts("rel=#{rel}")
+          if links.length >= 2
+            links.each.with_index(1) do |(_, link), i|
+              url, params = link
+              params = params.dup
+              params.delete('rel')
+              print(" (#{i}) <#{url}>")
+              print(" (#{params})") unless params.empty?
+              puts
+            end
+          else
+            url, params = links.first.last
+            params = params.dup
+            params.delete('rel')
+            print(" <#{url}>")
+            print(" (#{params})") unless params.empty?
+            puts
+          end
+        end
+        nil
+      end
+
+      def fill_in_template_params(template_params)
+        template_urls = current_links.keys.select { |k| k =~ RE_URI_TEMPLATE }
+        template_urls.each do |template_url|
+          expanded_url = URITemplate.new(template_url).expand(template_params) # Addressable のほうが良いかも
+          link_params = current_links.delete(template_url)
+          current_links.store(expanded_url, link_params)
+        end
+      end
+
+      def reset_current_links
+        @current_links = nil
+      end
+
+      def push_state(data, title, url)
+        if url == current_state.url
+          replace_state(data, title, url)
+        else
+          @stored_states.slice!((@current_index+1)..-1) # current_index の先から最後まで削除
+          state = build_state(data: data, title: title, url: url)
+          @stored_states.push(state)
+          @current_index += 1
+          reset_current_links
+          state
+        end
+      end
+
+      def replace_state(data, title, url)
+        reset_current_links
+        @stored_states[@current_index] = build_state(data: data, title: title, url: url)
+      end
+
+      def push(response_env)
+        url = response_env[:url]
+        push_state(response_env, '', url)
+      end
+
+      def back
+        if @current_index >= 1
+          @current_index -= 1
+          reset_current_links
+        end
+      end
+
+      def forward
+        if @current_index < @stored_states.length - 1
+          @current_index += 1
+          reset_current_links
+        end
+      end
+
+      private
+
+      def build_state(source = {})
+        State.new(
+          source[:data]  || {},
+          source[:title] || '',
+          source[:url]   || URI('navigation:blank')
+        )
+      end
+
+      def build_current_links
+        current_response_headers = current_state.data[:response_headers]
+        return HttpLinkHeader.new unless current_response_headers
+        links = current_response_headers['link'].to_s.scan(/<[^>]*>[^,]*/)
+        link_templates = current_response_headers['link-template'].to_s.scan(/<[^>]*>[^,]*/) # 自前でsplitする
+        HttpLinkHeader.new(links + link_templates)
+      end
+    end
+  end
+end

data/lib/faraday/hypermedia/link_extractor.rb

@@ -0,0 +1,88 @@
+require 'faraday_collection_json'
+require 'faraday_middleware'
+
+module Faraday
+  module Hypermedia
+    class LinkExtractorCJ < FaradayCollectionJSON::ParseCollectionJSON
+      def process_response(response_env)
+        # TODO: collectionのlinksしか取り出していない。itemsにも存在する
+        # TODO: itemsのselfがあれば取り出す
+        cj = parse(response_env[:body])
+        return if cj.links.empty? && cj.items.empty?
+        # link_arrays = cj.links.map do |link|
+        #   attrs = [['rel', link.rel]]
+        #   attrs << ['title', link.name] if link.name
+        #   [link.href, attrs]
+        # end
+        # link_value = LinkHeader.new(link_arrays).to_s
+        link_values = cj.links.map { |link|
+          value = %(<#{link.href}>;rel="#{link.rel}")
+          value += %(;title="#{link.name}") if link.name
+          value
+        }
+        item_values = cj.items.map { |item| %(<#{item.href}>;rel="item") if item.href }.compact
+        link_header = (link_values + item_values).join(',')
+        if response_env[:response_headers]['link']
+          response_env[:response_headers]['link'] += ",#{link_header}"
+        else
+          response_env[:response_headers]['link'] = link_header
+        end
+      end
+    end
+
+    class LinkExtractorGithub < FaradayMiddleware::ParseJson
+      def process_response(response_env)
+        doc = parse(response_env[:body])
+        if doc.is_a? Hash
+          link_template_props, link_props = doc.select { |name, _| name.end_with?('_url') }.partition { |_, url| url =~ RE_URI_TEMPLATE }
+          self_url = doc['url']
+          return if link_props.empty? && self_url.nil?
+          link_values = build_link_values(link_props)
+          link_values.unshift(%(<#{self_url}>;rel="self")) if self_url
+          item_props = doc.map { |name, c| [name, c['url']] if c.is_a?(Hash) && c['url'] }.compact
+          link_values.concat build_item_link_values(item_props)
+          link_template_values = build_link_values(link_template_props)
+        elsif doc.is_a? Array
+          # treat it as a collection
+          item_props = doc.map { |d| [d['name'], d['url']] if d['url'] }.compact
+          return if item_props.empty?
+          link_values = build_item_link_values(item_props)
+          link_template_values = []
+        else
+          return
+        end
+        link_header = link_values.join(',')
+        unless link_header.empty?
+          if response_env[:response_headers]['link']
+            response_env[:response_headers]['link'] += ",#{link_header}"
+          else
+            response_env[:response_headers]['link'] = link_header
+          end
+        end
+        link_template_header = link_template_values.join(',')
+        unless link_template_header.empty?
+          if response_env[:response_headers]['link-template']
+            response_env[:response_headers]['link-template'] += ",#{link_template_header}"
+          else
+            response_env[:response_headers]['link-template'] = link_template_header
+          end
+        end
+      end
+
+      private
+
+      def build_link_values(props)
+        props.map { |name, url|
+          rel = name.slice(0..-5) # '_url' を除いた名前
+          %(<#{url}>;rel="#{rel}") if url.to_s != ''
+        }.compact
+      end
+
+      def build_item_link_values(props)
+        props.map { |name, url|
+          %(<#{url}>;rel="item";title="#{name}") if url.to_s != ''
+        }.compact
+      end
+    end
+  end
+end

data/lib/faraday/hypermedia/navigation.rb

@@ -0,0 +1,48 @@
+module Faraday
+  module Hypermedia
+    class Navigation < Middleware
+      attr_reader :history
+
+      def initialize(app, history = nil, options = {})
+        super(app)
+        puts 'Navigation Enabled!'
+        @history = history || History.new
+      end
+
+      def call(request_env)
+        # request
+        url = request_env[:url]
+        if url.scheme == 'navigation'
+          case url.to
+          when 'back'
+            @history.back
+            request_env[:url] = @history.current_state.url
+          when 'forward'
+            @history.forward
+            request_env[:url] = @history.current_state.url
+          when 'go'
+            # TODO
+          when /\Alink(?:\((\d+)\))?\z/ # link or link(index)
+            index = (Regexp.last_match(1) || 1).to_i # one origin
+            matched_links = @history.current_links
+            unless url.queries.empty?
+              attr_name, attr_value = url.queries.first # TODO: multiple
+              matched_links = matched_links.select { |_ ,v| v[attr_name] && v[attr_name].include?(attr_value) } # TODO: multiple
+            end
+            raise 'cannot find link' if matched_links.empty?
+            matched_url = matched_links.to_a[index - 1].first
+            matched_url = URITemplate.new(matched_url).expand if matched_url =~ RE_URI_TEMPLATE
+            request_env[:url] = URI(matched_url)
+          else
+            raise "cannot use #{url.to}"
+          end
+        end
+
+        # response
+        @app.call(request_env).on_complete do |response_env|
+          @history.push response_env
+        end
+      end
+    end
+  end
+end

data/lib/faraday/hypermedia/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module Hypermedia
+    VERSION = "0.1.0"
+  end
+end

data/lib/uri/navigation.rb

@@ -0,0 +1,39 @@
+require 'uri'
+
+module URI
+  class Navigation < Generic
+    DEFAULT_PORT = nil
+    COMPONENT = [ :scheme, :to, :query ].freeze
+
+    def initialize(*arg)
+      super(*arg)
+      to, query = @opaque.split('?', 2)
+      @to = to
+      self.query = query
+    end
+
+    attr_reader :to
+
+    def query=(v)
+      return @query = nil unless v
+
+      x = v.to_str
+      v = x.dup if x.equal? v
+      v.encode!(Encoding::UTF_8) rescue nil
+      v.delete!("\t\r\n")
+      v.force_encoding(Encoding::ASCII_8BIT)
+      v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord}
+      v.force_encoding(Encoding::US_ASCII)
+      @query = v
+    end
+
+    def queries
+      @query.split('&').map { |x| x.split(/=/, 2) }.to_h
+    end
+
+    def to_s
+      "#{@scheme}:#{@to}" + (@query && !@query.empty? ? "?#{@query}" : '')
+    end
+  end
+  @@schemes['NAVIGATION'] = Navigation
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: faraday-hypermedia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toru KAWAMURA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http_link_header
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_collection_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: faraday-detailed_logger
+  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: faraday-http-cache
+  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: Faraday middleware that supports hypermedia client
+email:
+- tkawa@4bit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday-hypermedia.gemspec
+- lib/faraday-hypermedia.rb
+- lib/faraday/hypermedia.rb
+- lib/faraday/hypermedia/history.rb
+- lib/faraday/hypermedia/link_extractor.rb
+- lib/faraday/hypermedia/navigation.rb
+- lib/faraday/hypermedia/version.rb
+- lib/uri/navigation.rb
+homepage: https://github.com/tkawa/faraday-hypermedia
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Faraday middleware that supports hypermedia client
+test_files: []
+has_rdoc: