jekyll-amazon 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d26cfe071a4a29ceda2c35f3325a9ff459381d22
-  data.tar.gz: c46e953d7f3bd946faaa56da74efb154d28d1ee3
+  metadata.gz: 7f66481069447c54da0a8c885fa980eb19ec03f7
+  data.tar.gz: 7345bc5b5ab2176870692f8d78f0da8dfb44f019
 SHA512:
-  metadata.gz: 8db8af2c368a3d2883d85be286d16c38a81f3b2969e476bb0a34b310353d964a45b1227cc636a61921ab9da1942fba499510eec1a0265132d704455bbaa30678
-  data.tar.gz: 37815a9067a508d78526ce91f7b2402e1d20395ff71e5ab83c57b646b152b2edaf01b46aabb25ee2fc328d8dfd62c5b20904ac27350d70e35112556916317d72
+  metadata.gz: 8e0f1df60df9f6f21fac5926c57d9a45a680dc941ff6c44c9b0b935af6d528f5bbb7cbb8ce41a048bcfee5ee519145019c813e79d7e705f73c40ca252bbd2c53
+  data.tar.gz: f4d3fe974de53b5b75d7e961a9ee23848d36933d39c128ab656a427dca950057f3651c43ad36822a1a5af539e22508f9036d0a5ff9f7d47720d10cd5d7c992c0

data/README.md

@@ -26,12 +26,6 @@ And set the environment variables required by the Product Advertising API:
 
 (`ECS_ASSOCIATE_TAG` is the Tracking ID for your Affiliate account; `AWS_ACCESS_KEY_ID` and `AWS_SECRET_KEY` are your security credentials from your AWS account.  An AWS account is required for the use of this API.)
 
-Users outside of Japan will also want to set 
-
-	$ export ECS_COUNTRY=...
-
-with the two character country code of their Amazon Affiliate account (e.g. `'us'` for United States). 
-
 Finally, add the following to your site's `_config.yml`:
 
 ```
@@ -39,23 +33,34 @@ gems:
  - jekyll-amazon
 ```
 
-and if English labels are desired, 
+## Configuration
+
+Put the configuration in your _config.yml:
 
 ```
-amazon_locale : en
+jekyll-amazon:
+  locale: 'ja'  # label's language. default: 'en'
+  country: 'jp' # with the two character country code of their Amazon
+                # Affiliate account (e.g. `'us'` for United States).
+                # default: 'us'
+                # 'br'/'ca'/'cn'/'de'/'es'/'fr'/'in'/'it'/'jp'/'mx/'uk'/'us'
+  template_dir: '_templates' # original template directory
 ```
 
+
 ## Usage
 
 Use the tag as follows in your jekyll pages, posts and collections:
 
-
 ```liquid
 {% amazon 4083210443 detail %}
 ```
 
 
+## References
 
+- [Amazon Product Advertising API](https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html).
+- [jugend/amazon\-ecs: Ruby Amazon Product Advertising API](https://github.com/jugend/amazon-ecs)
 
 ## Contributing
 

data/lib/jekyll-amazon/amazon_tag.rb

@@ -2,6 +2,7 @@
 require 'amazon/ecs'
 require 'singleton'
 require 'i18n'
+require 'erb'
 
 module Jekyll
   module Amazon
@@ -26,40 +27,20 @@ module Jekyll
         description:      'EditorialReviews/EditorialReview/Content'
       }.freeze
 
-      ECS_ASSOCIATE_TAG = ENV['ECS_ASSOCIATE_TAG'] || ''
-      AWS_ACCESS_KEY_ID = ENV['AWS_ACCESS_KEY_ID'] || ''
-      AWS_SECRET_KEY = ENV['AWS_SECRET_KEY'] || ''
-
-      raise 'AWS_ACCESS_KEY_ID env variable is not set' if AWS_ACCESS_KEY_ID.empty?
-      raise 'AWS_SECRET_KEY env variable is not set' if AWS_SECRET_KEY.empty?
-      raise 'ECS_ASSOCIATE_TAG env variable is not set' if ECS_ASSOCIATE_TAG.empty?
-
       def initialize
         @result_cache = {}
         FileUtils.mkdir_p(CACHE_DIR)
       end
 
-      def setup(context)
-        site = context.registers[:site]
-        # ::Amazon::Ecs.debug = true
+      def setup(country)
+        ::Amazon::Ecs.debug = debug?
         ::Amazon::Ecs.configure do |options|
-          options[:associate_tag]     = ECS_ASSOCIATE_TAG
-          options[:AWS_access_key_id] = AWS_ACCESS_KEY_ID
-          options[:AWS_secret_key]    = AWS_SECRET_KEY
+          options[:associate_tag]     = ENV.fetch('ECS_ASSOCIATE_TAG')
+          options[:AWS_access_key_id] = ENV.fetch('AWS_ACCESS_KEY_ID')
+          options[:AWS_secret_key]    = ENV.fetch('AWS_SECRET_KEY')
           options[:response_group]    = RESPONSE_GROUP
-          options[:country]           = ENV['ECS_COUNTRY'] || 'jp'
+          options[:country]           = country
         end
-
-        setup_i18n(site)
-      end
-
-      def setup_i18n(site)
-        locale = 'ja'
-        locale = site.config['amazon_locale'] if site.config['amazon_locale']
-        I18n.enforce_available_locales = false
-        I18n.locale = locale.to_sym
-        dir = File.expand_path(File.dirname(__FILE__))
-        I18n.load_path = [dir + "/../../locales/#{locale}.yml"]
       end
 
       def item_lookup(asin)
@@ -70,13 +51,21 @@ module Jekyll
           res.first_item
         end
         raise ArgumentError unless item
+        save(asin, item)
+      end
+
+      private
+
+      def save(asin, item)
         data = create_data(item)
         write_cache(asin, data)
         @result_cache[asin] = data
         @result_cache[asin]
       end
 
-      private
+      def debug?
+        ENV.fetch('JEKYLL_AMAZON_DEBUG', 'false') == 'true'
+      end
 
       def read_cache(asin)
         path = File.join(CACHE_DIR, asin)
@@ -107,94 +96,55 @@ module Jekyll
       end
     end
 
-    class ItemAttribute
-      attr_accessor :key
-      attr_accessor :value
-
-      def initialize(key, value)
-        self.key = key
-        self.value = value
-      end
-
-      def to_html
-        str = "<div class=\"jk-amazon-info-#{key}\">"
-        str += labeled
-        str += '</div>'
-        str
-      end
-
-      def labeled
-        return '' if value.nil? || value.empty?
-        "<span class=\"jk-amazon-info-label\">#{I18n.t(key)} </span>#{value}"
-      end
-    end
-
     class AmazonTag < Liquid::Tag
-      attr_accessor :asin
-      attr_accessor :template_type
+      DEFAULT_LOCALE  = 'en'.freeze
+      DEFAULT_COUNTRY = 'us'.freeze
 
       def initialize(tag_name, markup, tokens)
         super
         parse_options(markup)
-        error "No ASIN given in #{tag_name} tag" if asin.nil? || asin.empty?
+        error "No ASIN given in #{tag_name} tag" if @asin.nil? || @asin.empty?
       end
 
       def render(context)
-        type = template_type || :detail
-        AmazonResultCache.instance.setup(context)
-        item = AmazonResultCache.instance.item_lookup(asin.to_s)
+        setup(context)
+        setup_i18n
+        item = AmazonResultCache.instance.item_lookup(@asin.to_s)
         return unless item
-        send(type, item)
+        render_from_file(@template_type, item)
       end
 
       private
 
+      def setup(context)
+        @site   = context.registers[:site]
+        @config = @site.config['jekyll-amazon'] || {}
+        country = @config['country'] || DEFAULT_COUNTRY
+        @template_dir = @config['template_dir']
+        AmazonResultCache.instance.setup(country)
+      end
+
+      def setup_i18n
+        locale = @config['locale'] || DEFAULT_LOCALE
+        I18n.enforce_available_locales = false
+        I18n.locale = locale.to_sym
+        file = File.expand_path("../../locales/#{locale}.yml", __dir__)
+        I18n.load_path = [file]
+      end
+
       def parse_options(markup)
         options = (markup || '').split(' ').map(&:strip)
-        self.asin = options.shift
-        self.template_type = options.shift || :title
-      end
-
-      def title(item)
-        url   = item[:detail_page_url]
-        title = item[:title]
-        format(
-          %(<a class="jk-amazon-info-title" href="%s" target="_blank">%s</a>),
-          url, title
-        )
-      end
-
-      def image(item)
-        url       = item[:detail_page_url]
-        title     = item[:title]
-        image_url = item[:medium_image_url]
-        str = <<-"EOS"
-<a class="jk-amazon-image" href="#{url}" target="_blank">
-  <img src="#{image_url}" alt="#{title}" />
-</a>
-  EOS
-        str.to_s
-      end
-
-      def detail(item)
-        attrs = {
-          author: item[:author],
-          publisher: item[:publisher],
-          date: item[:publication_date] || item[:release_date],
-          salesrank: item[:salesrank],
-          description: br2nl(item[:description])
-        }.map { |k, v| ItemAttribute.new(k, v).to_html }.join("\n")
-
-        str = <<-"EOS"
-<div class="jk-amazon-item">
-  #{image(item)}
-  <div class="jk-amazon-info">
-    #{title(item)}
-    #{attrs}
-  </div>
-</div>
-        EOS
-        str.to_s
+        @asin = options.shift
+        @template_type = options.shift || :title
+      end
+
+      def render_from_file(type, item)
+        if @template_dir
+          template_file = File.expand_path("#{type}.erb", @template_dir)
+          file = template_file if File.exist? template_file
+        end
+        file ||= File.expand_path("../../templates/#{type}.erb", __dir__)
+        ERB.new(open(file).read).result(binding)
       end
 
       def br2nl(text)

data/lib/jekyll-amazon/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Amazon
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/templates/detail.erb

@@ -0,0 +1,27 @@
+<div class="jk-amazon-item">
+  <a class="jk-amazon-image" href="<%= item[:detail_page_url] %>" target="_blank">
+    <img src="<%= item[:medium_image_url] %>" alt="<%= item[:title] %>" />
+  </a>
+  <div class="jk-amazon-info">
+    <a class="jk-amazon-info-title" href="<%= item[:detail_page_url] %>" target="_blank">
+      <%= item[:title] %>
+    </a>
+    <%
+      { 
+        author: item[:author],
+        publisher: item[:publisher],
+        date: item[:publication_date] || item[:release_date],
+        salesrank: item[:salesrank],
+        description: br2nl(item[:description])
+      }.each do |key, value|
+        next if value.nil? || value.empty?
+    %>
+    <div class="jk-amazon-info-<%= key %>">
+      <span class="jk-amazon-info-label">
+        <%= I18n.t(key) %>
+      </span>
+      <%= value %>
+    </div>
+    <% end %>
+  </div>
+</div>

data/templates/image.erb

@@ -0,0 +1,3 @@
+<a class="jk-amazon-image" href="<%= item[:detail_page_url] %>" target="_blank">
+  <img src="<%= item[:medium_image_url] %>" alt="<%= item[:title] %>" />
+</a>

data/templates/title.erb

@@ -0,0 +1,3 @@
+<a class="jk-amazon-info-title" href="<%= item[:detail_page_url] %>" target="_blank">
+  <%= item[:title] %>
+</a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-amazon
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - tokzk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazon-ecs
@@ -116,6 +116,9 @@ files:
 - lib/jekyll-amazon/version.rb
 - locales/en.yml
 - locales/ja.yml
+- templates/detail.erb
+- templates/image.erb
+- templates/title.erb
 homepage: https://github.com/tokzk/jekyll-amazon
 licenses:
 - MIT