ogp 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac04b68e554119d27453a1d23849c99eafa72199ecac95e34deded14824e9894
-  data.tar.gz: 16b167b85c8cffbf3df3292fe7f41a7b00a2f57f731806786a67679585b5ac5b
+  metadata.gz: b67e536cdab955dfbff8f93724732c051a19df9337f8560c3e77033728f45ace
+  data.tar.gz: e661bc0cbe6c0466db428ad1feb3e33f9e27e28d22e60308aab191fc7cdb78f4
 SHA512:
-  metadata.gz: f27db8019f8e34d972c859e9bec5ddc8365e3ab5fe77c0aebeedbfa81c2d243627af0b5b3e85dd9b67de0a2f5d7cd159d95c7ea8bb0a78f7ed0a7e9efdbe9c31
-  data.tar.gz: d7b980adaa3d90df2409795e6e3e20474fc3f8b19956ebe73c340b11a79bf68813633ae341462c1264489f96bcf0d0a3e34c3aecb4838ccd6fe452cd2dbb55e8
+  metadata.gz: eb53f0ea1c971692ae08c716ed8f2d5c4d11a9f1aa6baad942765babde03e53cd11803e0a3f89763c87a36461e8e4eb7894e28a38a918d36b2b299d7e85eeab7
+  data.tar.gz: 9d52e2948173d732604afd2ce22cca452ea880ddf030ded4ffdf52d1209c354d8e62547b6cdf508c4ef94542785e63b5a7c6edaea1a6e604085e143aa3d19c3d

data/README.md

@@ -41,6 +41,10 @@ open_graph.title # => "Open Graph protocol"
 open_graph.type # => "website"
 open_graph.image.url # => "http://ogp.me/logo.png"
 open_graph.url # => "http://ogp.me/"
+
+# All open graph tags are additionally stored in a `data` hash so that custom
+# open graph tags can still be accessed.
+open_graph.data["title"] # => "Open Graph protocol"
 ```
 
 ## Contributing

data/lib/ogp/open_graph.rb

@@ -5,6 +5,9 @@ REQUIRED_ATTRIBUTES = %w(title type image url).freeze
 
 module OGP
   class OpenGraph
+    # Accessor for storing all open graph data
+    attr_accessor :data
+
     # Required Accessors
     attr_accessor :title, :type, :url
     attr_accessor :images
@@ -24,6 +27,7 @@ module OGP
 
       source.force_encoding('UTF-8') if source.encoding != 'UTF-8'
 
+      self.data = {}
       self.images = []
       self.audios = []
       self.locales = []
@@ -51,6 +55,21 @@ module OGP
     def parse_attributes(document)
       document.xpath('//head/meta[starts-with(@property, \'og:\')]').each do |attribute|
         attribute_name = attribute.get('property').downcase.gsub('og:', '')
+
+        if data.has_key?(attribute_name)
+          # There can be multiple entries for the same og tag, see
+          # https://open.spotify.com/album/3NkIlQR6wZwPCQiP1vPjF8 for an example
+          # where there are multiple `restrictions:country:allowed` og tags.
+          #
+          # In this case store the content values as an array.
+          if !data[attribute_name].kind_of?(Array)
+            data[attribute_name] = [ data[attribute_name] ]
+          end
+          data[attribute_name] << attribute.get('content')
+        else
+          data[attribute_name] = attribute.get('content')
+        end
+
         case attribute_name
           when /^image$/i
             images << OpenStruct.new(url: attribute.get('content').to_s)
@@ -70,7 +89,15 @@ module OGP
             videos << OpenStruct.new unless videos.last
             videos.last[Regexp.last_match[1].gsub('-', '_')] = attribute.get('content').to_s
           else
-            instance_variable_set("@#{attribute_name}", attribute.get('content'))
+            begin
+              instance_variable_set("@#{attribute_name}", attribute.get('content'))
+            rescue NameError
+              warn("Some og tag names include colons `:`, such as Spotify song
+              pages (`restrictions:country:allowed`), which will result in a
+              NameError. Please rely on data[attribute_name] instead. Setting
+              top-level instance variables is deprecated and will be removed in
+              the next major version.")
+            end
         end
       end
     end

data/lib/ogp/version.rb

@@ -1,3 +1,3 @@
 module OGP
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/ogp.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'oga', '~> 2.15'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler', '>= 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'

data/spec/fixtures/custom_attributes.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta property="og:title" content="Way Out" />
+  <meta property="og:description" content="Way Out, an album by Waterstrider on Spotify" />
+  <meta property="og:url" content="https://open.spotify.com/album/3NkIlQR6wZwPCQiP1vPjF8" />
+  <meta property="og:image" content="https://i.scdn.co/image/ab67616d0000b273eab5104fe2284f59731dd3f7" />
+  <meta property="og:type" content="music.album" />
+  <meta property="music:musician" content="https://open.spotify.com/artist/731UNhwHMAcSsurgHJxPHC" />
+  <meta property="music:release_date" content="2019-05-10" />
+  <meta property="music:song" content="https://open.spotify.com/track/6bewGDfgcmCjbAE2XHbwCh" />
+  <meta property="music:song:disc" content="1" />
+  <meta property="music:song:track" content="1" />
+  <meta property="og:restrictions:country:allowed" content="AR" />
+  <meta property="og:restrictions:country:allowed" content="AT" />
+  <meta property="og:restrictions:country:allowed" content="BG" />
+  <title></title>
+</head>
+<body>
+</body>
+</html>

data/spec/ogp/open_graph_spec.rb

@@ -141,5 +141,17 @@ describe OGP::OpenGraph do
         expect(open_graph.image.url).to eql('https://www.example.com/image.jpg')
       end
     end
+
+    context 'with custom attributes' do
+      it 'should include them to the data hash' do
+        content = File.read("#{File.dirname(__FILE__)}/../fixtures/custom_attributes.html", encoding: 'ASCII-8BIT')
+        open_graph = OGP::OpenGraph.new(content)
+
+        expect(open_graph.title).to eql('Way Out')
+        expect(open_graph.data['title']).to eql(open_graph.title)
+        expect(open_graph.data['restrictions:country:allowed'].size).to eql(3)
+        expect(open_graph.data['restrictions:country:allowed'][0]).to eql('AR')
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jean-Philippe Couture
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-06 00:00:00.000000000 Z
+date: 2019-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
@@ -102,6 +102,7 @@ files:
 - lib/ogp/version.rb
 - ogp.gemspec
 - spec/fixtures/audio_structured_attributes.html
+- spec/fixtures/custom_attributes.html
 - spec/fixtures/i18n_encoding.html
 - spec/fixtures/image_structured_attributes.html
 - spec/fixtures/missing_required_attributes.html
@@ -137,6 +138,7 @@ specification_version: 4
 summary: Simple Ruby library for parsing Open Graph prototocol information.
 test_files:
 - spec/fixtures/audio_structured_attributes.html
+- spec/fixtures/custom_attributes.html
 - spec/fixtures/i18n_encoding.html
 - spec/fixtures/image_structured_attributes.html
 - spec/fixtures/missing_required_attributes.html