apdm 0.0.15

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2QzMjJlZGYzYTJkYzZjYTkyZmM2N2IwNGE4NzI3MGYwMGM4YWU1ZQ==
+  data.tar.gz: !binary |-
+    ZDYxMmJkOGE4MGNlMzg1ZTI5MWNmMWIyYjMxYmQ3MWQyMDUyMWU3ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGQ5MDA4YjY4ODUwY2ZmMjZiYmJiM2EzYzVkN2M1MmI4N2U3NzRjNWZmNDM1
+    YzBlODk4MTVmNGZiODg2ZjMwNmZlMzQwYjQxMDBjYzRhMTNkMTQ4NzRmODk5
+    NDVlNTU2MDg2NmNkY2JjM2U2NjUwZGNiZDE4ZmRiOWI4NzQ4OTI=
+  data.tar.gz: !binary |-
+    NzQzNDA1MTFmZWUwOTM3NGNlZTEyZGRlMzNhMGUyMGQ0NDVmOGI1MGQ0MDAw
+    N2EwMmQ5N2MxMTQyMDMwZjBlYTkzMWJjMmEyZWEwMzAxNjVmMDdkMjlmZGU3
+    ODMwZThkOWZhNjUwNzgzOWJiNTRiOGEyNzQxZjM3YjI3NWFjM2I=

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+.idea
+Gemfile.lock
+pkg/*
+test/fixtures/config.yml
+log/
+.approvals
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apdm.gemspec
+gemspec

data/README.md

@@ -0,0 +1,223 @@
+# APDM
+
+A-Pressens Digitale Medier
+
+Bucket for APDM specific stuff.
+
+Usage intended for the pebble _Pulp_ and the apps _Lifeloop_ and _Bandwagon_, _Strider_, should it expand to include multiple papers, as well as any apps that come out of the _Evergreen_ project.
+
+## Channels
+
+    channel = Channel.find('avisnavn')
+
+    channel.name
+    => 'Avisnavn'
+
+    channel.domain
+    => 'avisnavn.no'
+
+    channel.ad_tech
+    => 123
+
+    # ... and loads of other handy methods
+
+## Design Elements
+
+The api key is just an identifier, and is not used for authorization. In other words, you can make them up as you go along.
+
+    api = APDM::DesignElements.new('avisnavn', :api_key => 'bandwagon')
+
+### Header/Footer
+
+Each newspaper has a standard header and footer along with the css necessary to display it.
+This header changes regularly. We cache these for a day by default.
+
+    api.header
+    api.footer
+    api.css
+
+### SiteStat
+
+These are tracking scripts used for analytics. It is common to give each type of page within an application its own key.
+
+    api.site_stat('personalia.bursdag.hilsen.123456')
+
+## RSS Feeds
+
+The newspapers each have an RSS feed:
+
+    channel = Channel.find 'avisnavn'
+    feed = APDM::Feed.new(channel)
+
+    feed.fetch
+
+You can specify extra parameters for the number of entries it should return:
+
+    feed.fetch("amount" => 5)
+
+Also, newspapers sometimes set up specific sections, like 'bandwagon', or 18368. These are specified as follows:
+
+    feed.fetch("sectionId" => 'bandwagon')
+
+## AdTech
+
+AdTech ads are managed by Elisabeth Drange Tønnessen <elisabeth.tonnessen@apdm.no>. We receive a standardized .csv file with ad data, keyed off of a `website id`. The `website_id` in the .csv file corresponds to the `ad_tech_id` in the `Channels` list.
+
+When APDM says that they just want to use the "default origo ads" this doesn't mean actual origo ads, it means the ads that we have stored with this gem.
+
+It is important, if you create the snippets ahead of time, to make sure that all the ads on a single page are served with a uniq group id.
+We use a large rand: "grp=12345678990". This identifies them as having been shown together, simultaneously.
+
+## Sinatra extensions and workarounds for evil APDM proxy
+
+If you are writing a Sinatra app that is going to live behind the evil apdm proxy, there's a Sinatra extension for you.
+
+Enable it with:
+
+    require 'apdm/sinatra'
+
+and adding this line to your Sinatra App class:
+
+    register Sinatra::APDM
+
+### Sinatra helpers
+
+The following helper methods will be registered:
+
+* `current_channel` Returns the current channel (based on current domain name - avisnavn.no if in development)
+* `design_elements` Returns the DesignElements instance for the current channel (see Design Elements above)
+* `ad_tech` Returns the AdTech instance for current channel
+* `design_elements_css_path` Returns the path (sinatra route) to where the css for current channel is published. Use in your templates to load css for channel, i.e. `%link{ :href => design_elements_css_path, :rel => "stylesheet", :type => "text/css" }`
+* `ad_tech_api_js` Returns a JavaScript snippet that defines functionality (a global `window.api` object with several methods)  needed by the ad_tech scripts. If you get a lot of `Uncaught ReferenceError: api is not defined` you probably want to include the following in your template:
+
+```haml
+  %script
+    = ad_tech_api_js
+```
+
+In order to make design elements or ad tech work properly, you need set a couple of configuration options:
+
+* `set_design_elements_api_key` The api key for design elements (see above)
+
+* `set_ad_tech_context_prefix` The context_key/context_prefix of your application (i.e. `bandwagon`)
+
+### Workarounds
+
+You probably want to enable workarounds and cache headers proven to work with the evil apdm proxy (see the following example)
+
+### Example (all options enabled):
+
+```rb
+class MyApp < Sinatra::Base
+
+  register Sinatra::APDM
+  apdm_configure do
+    set_design_elements_api_key "kalender"
+    set_ad_tech_context_prefix "kalender"
+    enable_apdm_proxy_workarounds
+    enable_apdm_cache_headers
+  end
+  # (...)
+```
+
+### Usage
+
+For each page request, you can instantiate an `ad_tech` ad repository for your current channel.
+This needs to know what context (application, possibly which part of the application) the ads are being shown in.
+
+    ad_tech = AdTech.new(current_channel, :context_key => 'bandwagon') # e.g. 'bandwagon', or 'origo+profile'
+
+    ad_tech.slot(:toppbanner)
+    ad_tech.slot(:bunnbanner)
+
+    ad_tech.loader_scripts
+
+It is possible to add local context in addition to the app context. For example, in Lifeloop, we specify `personalia+<greeting-kind>` on the greeting category pages as well as individual greeting pages.
+
+    ad_tech = AdTech.new(current_channel, :context_key => 'personalia')
+
+    ad_tech.slot(:toppbanner, :local_context => 'mothersday')
+
+    => 'personalia+mothersday'
+
+## Saxo
+
+Origo/Apressen Web-to-Print module.
+
+The local newspapers use Saxo to manage their images. This module writes metadata to jpg images for print, and transfers them to an FTP server, resulting in the images being pulled directly into the saxo system at the local papers.
+
+## Options
+
+`APDM::Saxo` needs to be initialized with a hash containing the server connection details.
+For convenience, these live in the Channel objects.
+
+    channel = Channel.find 'avisnavn'
+    channel.saxo_config
+    => { :server => 'ftp.example.com', :username => 'username', :password => 'password', :remote_dir => 'remote/dir' }
+
+## Metadata
+
+The metadata is a hash with the following keys:
+
+    {
+      :keywords => 'some keywords',
+      :byline => 'the byline',
+      :headline => 'the headline',
+      :credit => 'the credits',
+      :source => 'the source',
+      :copyright => 'the copyright',
+      :caption => 'a caption'
+    }
+
+## Publication Dates (_Issues_)
+
+Usually sometime before Christmas, someone realizes that we're running
+out of publication dates for some of the newspapers.
+
+The dates of each issue are delivered to us in a variety of formats, typically
+an excel in an encoding which is not UTF-8, and with varying columns and date formats.
+
+Til now, we have then massaged this in order to get a UTF-8 encoded .csv file
+that has the following fields:
+
+YYYY-MM-DD;Issue Number;Acronym;NEWSPAPER NAME IN ALL CAPS
+
+We don't use the issue number or acronym for anything. Also the acronyms are not unique.
+
+Ideally we would just get the date and the domain name:
+
+YYYY-MM-DD;avisnavn.no
+
+To import this, replace the `config/issues.csv` file with the newly massaged replacement,
+and then run the command to import it:
+
+    ./bin/apdm import_issues
+
+
+## Usage
+
+The default behavior is to take the image located at `./localname.jpg`, write the metadata to it, and transfer it to the remote destination.
+
+    saxo = APDM::Saxo.new(options)
+
+    photo = saxo.write(metadata).to('localname.jpg', '/some/path')
+    saxo.transfer(photo)
+
+If a `:source` is provided, the image will be downloaded to `/some/path/localname.jpg` before proceeding.
+
+    saxo = APDM::Saxo.new(options)
+
+    photo = saxo.write(metadata).to('localname.jpg', '/some/path', :source => 'http://www.example.com/remote.jpg')
+    saxo.transfer(photo)
+
+`saxo.transfer` returns true if it suceeded, otherwise false.
+
+## Acceptance Test
+
+There is an acceptance test in `/test`. This test by itself covers 98.99% of the saxo module in the project.
+
+To run it
+
+* copy `test/config-example.yml` to `test/config.yml`
+* edit to taste
+* run `rspec test`

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/apdm.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'apdm/version'
+
+Gem::Specification.new do |s|
+  s.name        = "apdm"
+  s.version     = APDM::VERSION
+  s.authors     = ["Katrina Owen"]
+  s.email       = ["katrina.owen@gmail.com"]
+  s.homepage    = "https://github.com/bengler/apdm"
+  s.summary     = %q{APDM local paper stuff.}
+  s.description = %q{A collection of APDM local paper-related things.}
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "approvals"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "timecop"
+  s.add_runtime_dependency "curb"
+  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "feedzirra", "~>0.2.0.rc2"
+  s.add_runtime_dependency "rgeo"
+  s.add_runtime_dependency "rgeo-geojson"
+  s.add_runtime_dependency "queryparams"
+  s.add_runtime_dependency "unicode"
+
+end

data/bin/apdm

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require_relative '../lib/cli'
+
+APDM::CLI.start

data/features/ad_tech.feature

@@ -0,0 +1,11 @@
+Feature: AdTech Ad Loaders
+
+  Display A-presse ads by inserting their old-school custom ad loaders
+  into the page.
+
+  Scenario: Render "toppbanner" and "bunnbanner" ad tech ads
+    Given an AdTech instance for Finnmark Dagblad
+    When toppbanner is slotted
+    And bunnbanner is slotted
+    Then the placeholders for toppbanner and bunnbanner are rendered
+    And loader scripts are included for both toppbanner and bunnbanner

data/features/step_definitions/ad_tech_steps.rb

@@ -0,0 +1,19 @@
+Given /^an AdTech instance for Finnmark Dagblad$/ do
+  channel = APDM::Channel.find('finnmarkdagblad')
+  @ad_tech = APDM::AdTech.new(channel, :group_id => 3, :context_key => 'cucumber+features')
+end
+
+When /^(\w+) is slotted$/ do |ad_key|
+  @placeholders ||= ""
+  @placeholders << @ad_tech.slot(ad_key.to_sym)
+end
+
+Then /^the placeholders for toppbanner and bunnbanner are rendered$/ do
+  Approvals.verify(@placeholders, :name => "ad tech placeholders")
+end
+
+Then /^loader scripts are included for both toppbanner and bunnbanner$/ do
+  Approvals.verify(@ad_tech.loader_scripts, :name => "ad tech loader scripts")
+end
+
+

data/features/support/env.rb

@@ -0,0 +1,5 @@
+$:.unshift "#{File.dirname(__FILE__)}/../../lib/"
+
+require 'approvals'
+require 'apdm'
+

data/fixtures/approvals/ad_tech_loader_scripts.approved.txt

@@ -0,0 +1,42 @@
+<div id="adtech_loader_scripts" style="display:none;">
+  <div id="adtech_toppbanner_loader">
+    <!--AdTech Loader | Tag for network 838 : A-Pressen Multimedia Salg | Website: Origin - Finnmark Dagblad | Placement: Origo Toppbanner 980x150 (2984117) -->
+  <script>
+    document.write('<scr'+'ipt language="javascript1.1" src="http://adserver.adtech.de/addyn/3.0/838/2984117/0/1744/ADTECH;loc=100;target=_blank;key=cucumber+features;grp=3;misc='+new Date().getTime()+'"></scri'+'pt>');
+  </script>
+  <noscript>
+    <a href="http://adserver.adtech.de/adlink/3.0/838/2984117/0/1744/ADTECH;loc=300;key=cucumber+features;grp=3" target="_blank">
+      <img src="http://adserver.adtech.de/adserv/3.0/838/2984117/0/1744/ADTECH;loc=300;key=cucumber+features;grp=3" border="0" width="980" height="150">
+    </a>
+  </noscript>
+  </div>
+         <script>
+  (function() {
+    var loader = document.getElementById('adtech_toppbanner_loader');
+    var placeholder = document.getElementById('adtech_toppbanner_placeholder');
+    placeholder.innerHTML = loader.innerHTML;
+    loader.innerHTML = '';
+  }());
+</script>
+
+  <div id="adtech_bunnbanner_loader">
+    <!--AdTech Loader | Tag for network 838 : A-Pressen Multimedia Salg | Website: Origin - Finnmark Dagblad | Placement: Origo Bunnbanner 980x150 (2984119) -->
+  <script>
+    document.write('<scr'+'ipt language="javascript1.1" src="http://adserver.adtech.de/addyn/3.0/838/2984119/0/1744/ADTECH;loc=100;target=_blank;key=cucumber+features;grp=3;misc='+new Date().getTime()+'"></scri'+'pt>');
+  </script>
+  <noscript>
+    <a href="http://adserver.adtech.de/adlink/3.0/838/2984119/0/1744/ADTECH;loc=300;key=cucumber+features;grp=3" target="_blank">
+      <img src="http://adserver.adtech.de/adserv/3.0/838/2984119/0/1744/ADTECH;loc=300;key=cucumber+features;grp=3" border="0" width="980" height="150">
+    </a>
+  </noscript>
+  </div>
+         <script>
+  (function() {
+    var loader = document.getElementById('adtech_bunnbanner_loader');
+    var placeholder = document.getElementById('adtech_bunnbanner_placeholder');
+    placeholder.innerHTML = loader.innerHTML;
+    loader.innerHTML = '';
+  }());
+</script>
+
+</div>

data/fixtures/approvals/ad_tech_placeholders.approved.txt

@@ -0,0 +1,6 @@
+<div id="adtech_toppbanner_placeholder" style="height: 150px; width: 980px;">
+  Annonse
+</div>
+<div id="adtech_bunnbanner_placeholder" style="height: 150px; width: 980px;">
+  Annonse
+</div>

data/lib/apdm.rb

@@ -0,0 +1,24 @@
+require 'apdm/design_elements'
+require 'apdm/channel'
+require 'apdm/network'
+require 'apdm/channels'
+require 'apdm/saxo'
+require 'apdm/null_cache'
+require 'apdm/ad_tech'
+require 'apdm/feed'
+require 'apdm/local_paper_area'
+require 'apdm/credentials'
+require 'apdm/origo'
+require 'apdm/issues'
+
+module APDM
+
+  class << self
+    attr_writer :cache
+
+    def cache
+      @cache ||= NullCache.new
+    end
+  end
+
+end

data/lib/apdm/ad_tech.rb

@@ -0,0 +1,96 @@
+require 'csv'
+require 'apdm/ad_tech/data'
+require 'apdm/ad_tech/ad_loader'
+require 'securerandom'
+
+module APDM
+  class AdTech
+
+    FORMATS = [:toppbanner, :bunnbanner, :skyskraper_1, :artikkelboard]
+
+    class << self
+      attr_writer :path_to_csv_file, :data
+      def path_to_csv_file
+        @path_to_csv_file ||= File.dirname(__FILE__) + '/ad_tech/ads.csv'
+      end
+
+      def load
+        @data = Data.new(path_to_csv_file)
+      end
+
+      def data
+        @data ||= Data.new(path_to_csv_file)
+      end
+    end
+
+    attr_reader :channel, :loaders, :data, :group_id
+    def initialize(channel, options = {})
+      @channel = channel
+      @context_key = options[:context_key]
+      @loaders = []
+      @data = options[:data] || AdTech.data.for(channel)
+      @group_id = options[:group_id] || rand(10**10)
+    end
+
+    def context_key(refinement = nil)
+      "#{@context_key}+#{refinement}".chomp('+')
+    end
+
+    def slot(key, options = {})
+      slotted = ad_loader(key, options)
+      loaders << slotted
+      placeholder_div slotted
+    end
+
+    def ad_loader(key, options = {})
+      AdLoader.new data_for(key, options)
+    end
+
+    def placeholder_div(loader)
+      s = <<-PLACEHOLDER.gsub(/^\s{8}/, '').chomp
+        <div id="#{loader.dom_prefix}_placeholder" style="width: #{loader.width}px;">
+          Annonse
+        </div>
+
+      PLACEHOLDER
+    end
+
+    def loader_scripts
+      html = "<div id=\"adtech_loader_scripts\" style=\"display:none;\">\n"
+
+      loaders.each do |loader|
+        html << wrap(loader)
+      end
+
+      html << '</div>'
+    end
+
+    def wrap(loader)
+      s = <<-HTML.gsub(/^\s{8}/, '')
+          <div id="#{loader.dom_prefix}_loader">
+            #{loader}
+         </div>
+         #{postloader(loader)}
+        HTML
+      s
+    end
+
+    def data_for(key, options = {})
+      data[key].merge(:group_id => group_id, :context_key => context_key(options[:local_context]))
+    end
+
+    def postloader(loader)
+      s = <<-SCRIPT
+        <script>
+          (function() {
+            var loader = document.getElementById('#{loader.dom_prefix}_loader');
+            var placeholder = document.getElementById('#{loader.dom_prefix}_placeholder');
+            placeholder.innerHTML = loader.innerHTML;
+            loader.innerHTML = '';
+          }());
+        </script>
+      SCRIPT
+    end
+
+  end
+end