altmetric_badger 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d9d1ab56412d2975c02203170f5b776d6bc5410
+  data.tar.gz: e5641af3af85d0ffa3f5760d660c67c471a05c05
+SHA512:
+  metadata.gz: e4a22eddfa3448b3a5cfcc05decee2aa90dd89d7e4f53444c26fe80292452627ce0381a4428425c571d96962bf41de09f410530d65f938390d8a34224d7f2cfe
+  data.tar.gz: 09f99061ca3ebde114c2ff3b0d309df9bd44683b953817fa4041d22452056c85a02b11f4006f34d6827659726966ef7d39fb173e3ecf0c7d5852ea5a58954a60

data/data/sources.json

@@ -0,0 +1,82 @@
+[
+  {
+    "code": "1",
+    "color": "#F4006E",
+    "key": "f1000"
+  },
+  {
+    "code": "?",
+    "color": "#DEDEDE",
+    "key": null
+  },
+  {
+    "code": "b",
+    "color": "#FFD140",
+    "key": "blogs"
+  },
+  {
+    "code": "d",
+    "color": "#9F79F2",
+    "key": "policy"
+  },
+  {
+    "code": "e",
+    "color": "#EFEFEF",
+    "key": "peer_reviews"
+  },
+  {
+    "code": "f",
+    "color": "#2445BD",
+    "key": "facebook"
+  },
+  {
+    "code": "g",
+    "color": "#E065BB",
+    "key": "googleplus"
+  },
+  {
+    "code": "l",
+    "color": "#1E90FF",
+    "key": "linkedin"
+  },
+  {
+    "code": "m",
+    "color": "#FF0000",
+    "key": "news"
+  },
+  {
+    "code": "p",
+    "color": "#CC6600",
+    "key": "pinterest"
+  },
+  {
+    "code": "q",
+    "color": "#DEDEDE",
+    "key": "q&a"
+  },
+  {
+    "code": "r",
+    "color": "#D5E8F0",
+    "key": "reddit"
+  },
+  {
+    "code": "s",
+    "color": "#FFB33B",
+    "key": "weibo"
+  },
+  {
+    "code": "t",
+    "color": "#74CFED",
+    "key": "twitter"
+  },
+  {
+    "code": "v",
+    "color": "#94DB5E",
+    "key": "video"
+  },
+  {
+    "code": "w",
+    "color": "#E7E7E7",
+    "key": "wikipedia"
+  }
+]

data/lib/altmetric_badger.rb

@@ -0,0 +1,118 @@
+require 'color'
+require 'json'
+require 'uri'
+
+# Wrap an Altmetric data hash and provide translation to badge URIs
+class AltmetricBadger
+  BADGE_TYPES = %i(donut pie helix bar)
+  BASE_HOST = 'altmetric-badges.a.ssl.fastly.net'
+
+  class InvalidDataError < StandardError; end
+
+  def initialize(score: nil, data:)
+    fail InvalidDataError unless data && data.respond_to?(:sort_by)
+    @data = data
+    @score = score
+  end
+
+  BADGE_TYPES.each do |type|
+    define_method "to_#{type}_uri" do |size: 640, svg: false, show_score: true, ssl: true|
+      (ssl ? URI::HTTPS : URI::HTTP).build(
+        host: BASE_HOST,
+        path: '/',
+        query: "style=#{ type }&score=#{ score if show_score }&types=#{ type_string }&size=#{ size }#{ '&svg' if svg }"
+      )
+    end
+  end
+
+  private
+
+  attr_reader :data, :score
+
+  SEGMENT_COUNT = 8
+  DEFAULT_TYPE_STRING = '?' * SEGMENT_COUNT
+
+  class << self
+    def sources
+      @sources ||= JSON.parse(
+        File.read(
+          File.join(__dir__, '..', 'data', 'sources.json')
+        )
+      )
+    end
+
+    def sources_key_map
+      @sources_key_map ||= sources.map { |e| [e['key'], e] }.to_h
+    end
+
+    def sources_code_map
+      @sources_code_map ||= sources.map { |e| [e['code'], e] }.to_h
+    end
+
+    def key_for_code(code)
+      sources_code_map.fetch(code, {})['key']
+    end
+
+    def code_for_key(type)
+      sources_key_map.fetch(type, sources_key_map[nil])['code']
+    end
+
+    def color_for_code(code)
+      sources_code_map.fetch(code, sources_key_map[nil])['color']
+    end
+  end
+
+  # Return string of type codes that Altmetric badge URI uses
+  def type_string
+    return DEFAULT_TYPE_STRING unless total_posts > 0
+
+    segments_to_string(
+      apportion_segments(
+        post_percentages.keys.last(SEGMENT_COUNT)
+      )
+    )
+  end
+
+  # Return a hash of each post type to the percentage of posts of that type
+  def post_percentages
+    @post_percentages ||= data.sort_by { |_, v| v }.map do |type, count|
+      [self.class.code_for_key(type), (count / total_posts.to_f)]
+    end.to_h
+  end
+
+  # Divide segments among all post types, reflecting their proportion, and
+  # ensuring that the most popular SEGMENT_COUNT post types receive at least
+  # one segment each
+  def apportion_segments(segments)
+    (SEGMENT_COUNT - segments.length).times do
+      segments << post_percentages.max_by { |_, v| v }.first
+      post_percentages[segments.last] -= (1 / SEGMENT_COUNT.to_f)
+    end
+    segments
+  end
+
+  # Return the total number of posts in the data hash
+  def total_posts
+    @total_posts ||= data.values.reduce(:+) || 0
+  end
+
+  # Sort list of segments by apparent brightness and return combined string
+  def segments_to_string(segments)
+    segments.sort do |segment1, segment2|
+      color_difference_value(segment1, segment2)
+    end.join
+  end
+
+  # Calculate an absolute difference value between two colors
+  # This is pretty stupid and broken, but we need to keep the same behaviour
+  # as the Altmetric API so that the donuts don't look different.
+  def color_difference_value(segment1, segment2)
+    color1, color2 = [segment1, segment2].map do |color|
+      Color::RGB.from_html(self.class.color_for_code(color))
+    end.map(&:to_hsl)
+
+    %i(hue saturation brightness).map do |n|
+      color1.send(n) - color2.send(n)
+    end.reduce(:+)
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: altmetric_badger
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matthew MacLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A gem which produces Altmetric badge URIs from a data hash
+email: matt@umm.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- data/sources.json
+- lib/altmetric_badger.rb
+homepage: http://github.com/altmetric/altmetric-badger
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Altmetric Badge generator
+test_files: []