Module: Commonmeta::Readers::JsonFeedReader

Included in:
CLI, MetadataUtils
Defined in:
lib/commonmeta/readers/json_feed_reader.rb

Instance Method Summary collapse

Instance Method Details

#get_doi_prefix_by_blog_id(blog_id) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 190

def get_doi_prefix_by_blog_id(blog_id)
  # for generating a random DOI.

  url = json_feed_by_blog_url(blog_id)
  response = HTTP.get(url)
  return nil unless response.status.success?

  post = JSON.parse(response.body.to_s)
  post.to_h.dig("prefix")
end

#get_doi_prefix_by_json_feed_item_id(id) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 201

def get_doi_prefix_by_json_feed_item_id(id)
  # for generating a random DOI. Prefix is based on the blog id.

  url = json_feed_item_by_id_url(id)
  response = HTTP.get(url)
  return nil unless response.status.success?

  post = JSON.parse(response.body.to_s)
  post.to_h.dig("blog", "prefix")
end

#get_funding_references(meta) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 131

def get_funding_references(meta)
  # check that relationships resolve and have type "HasAward"
  Array.wrap(meta["relationships"]).reduce([]) do |sum, relationship|
    begin
      # funder is European Commission
      if validate_prefix(relationship["url"]) == "10.3030" || URI.parse(relationship["url"]).host == "cordis.europa.eu"
        relationship["funderIdentifier"] = "http://doi.org/10.13039/501100000780"
        relationship["funderName"] = "European Commission"
        relationship["awardNumber"] = relationship["url"].split("/").last
      end
      if relationship["type"] == "HasAward" && relationship["funderName"]
        sum << {
          "funderIdentifier" => relationship["funderIdentifier"],
          "funderName" => relationship["funderName"],
          "awardNumber" => relationship["awardNumber"],
        }
      end
    rescue => error
      # puts "Error: #{error.message}"
      # puts "Error: #{reference}"
    end

    sum
  end
end

#get_json_feed_by_blog(blog_id) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 179

def get_json_feed_by_blog(blog_id)
  # get all JSON Feed items from a particular blog

  url = json_feed_by_blog_url(blog_id)
  response = HTTP.get(url)
  return { "string" => nil, "state" => "not_found" } unless response.status.success?

  blog = JSON.parse(response.body.to_s)
  blog["items"].map { |item| item["id"] }.first
end

#get_json_feed_item(id: nil, **options) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 7

def get_json_feed_item(id: nil, **options)
  return { "string" => nil, "state" => "not_found" } unless id.present?

  url = normalize_id(id)
  response = HTTP.get(url)
  return { "string" => nil, "state" => "not_found" } unless response.status.success?

  { "string" => response.body.to_s }
end

#get_json_feed_not_indexed ⇒ Object 



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 168

def get_json_feed_not_indexed
  # get JSON Feed items not indexed in Crossref since they have been last updated

  url = json_feed_not_indexed_url
  response = HTTP.get(url)
  return { "string" => nil, "state" => "not_found" } unless response.status.success?

  posts = JSON.parse(response.body.to_s)
  posts.map { |post| post["id"] }.first
end

#get_json_feed_unregistered ⇒ Object 



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 157

def get_json_feed_unregistered
  # get JSON Feed items not registered as DOIs

  url = json_feed_unregistered_url
  response = HTTP.get(url)
  return { "string" => nil, "state" => "not_found" } unless response.status.success?

  posts = JSON.parse(response.body.to_s)
  posts.map { |post| post["id"] }.first
end

#get_references(meta) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 92

def get_references(meta)
  # check that references resolve
  Array.wrap(meta["reference"]).reduce([]) do |sum, reference|
    begin
      if reference["doi"] && validate_doi(reference["doi"])
        response = HTTP.follow
          .headers(:accept => "application/vnd.citationstyles.csl+json")
          .get(reference["doi"])
        csl = JSON.parse(response.body.to_s)
        sum << reference.merge("title" => csl["title"], "publicationYear" => csl.dig("issued", "date-parts", 0, 0).to_s) if [200, 301, 302].include? response.status
      elsif reference["url"] && validate_url(reference["url"]) == "URL"
        sum << reference if [200, 301, 302].include? HTTP.head(reference["url"]).status
      end
    rescue => error
      # puts "Error: #{error.message}"
      # puts "Error: #{reference}"
    end

    sum
  end
end

#get_related_identifiers(meta) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 114

def get_related_identifiers(meta)
  # check that relationships resolve and has a supported type
  supported_types = %w[IsIdenticalTo IsPreprintOf IsTranslationOf]
  Array.wrap(meta["relationships"]).reduce([]) do |sum, relationship|
    begin
      if supported_types.include?(relationship["type"]) && [200, 301, 302].include?(HTTP.head(relationship["url"]).status)
        sum << { "id" => relationship["url"], "type" => relationship["type"] }
      end
    rescue => error
      # puts "Error: #{error.message}"
      # puts "Error: #{reference}"
    end

    sum
  end
end

#read_json_feed_item(string: nil, **options) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/commonmeta/readers/json_feed_reader.rb', line 17

def read_json_feed_item(string: nil, **options)
  read_options = ActiveSupport::HashWithIndifferentAccess.new(options.except(:doi, :id, :url,
                                                                             :sandbox, :validate, :ra))

  meta = string.present? ? JSON.parse(string) : {}

  if (meta.dig("blog", "status") == "archived")
    url = normalize_url(meta.fetch("archive_url", nil))
  else
    url = normalize_url(meta.fetch("url", nil))
  end
  id = options[:doi] ? normalize_doi(options[:doi]) : normalize_id(meta.fetch("doi", nil))
  id = normalize_url(meta.fetch("url", nil)) if id.blank?

  type = "Article"
  contributors = if meta.fetch("authors", nil).present?
      get_authors(from_json_feed(Array.wrap(meta.fetch("authors"))))
    else
      [{ "type" => "Organization", "name" => ":(unav)" }]
    end
  titles = [{ "title" => meta.fetch("title", nil) }]
  publisher = { "name" => meta.dig("blog", "title") }

  date = {}
  date["published"] = get_date_from_unix_timestamp(meta.dig("published_at")) if meta.dig("published_at").present?
  date["updated"] = get_date_from_unix_timestamp(meta.dig("updated_at")) if meta.dig("updated_at").present?

  license = if meta.dig("blog", "license").present?
      hsh_to_spdx("rightsURI" => meta.dig("blog", "license"))
    end
  home_page_url = normalize_url(meta.dig("blog", "home_page_url"))
  container = if meta.dig("blog", "title").present?
      { "type" => "Periodical",
        "title" => meta.dig("blog", "title"),
        "identifier" => home_page_url,
        "identifierType" => "URL" }
    end

  descriptions = if meta.fetch("summary", nil).present?
      [{ "description" => sanitize(meta.fetch("summary", nil)),
         "descriptionType" => "Abstract" }]
    else
      []
    end
  language = meta.fetch("language", nil) || meta.dig("blog", "language")
  state = id.present? || read_options.present? ? "findable" : "not_found"
  subjects = Array.wrap(meta.dig("blog", "category")).reduce([]) do |sum, subject|
    sum += name_to_fos(subject.underscore.humanize)

    sum
  end
  references = get_references(meta)
  funding_references = get_funding_references(meta)
  related_identifiers = get_related_identifiers(meta)
  alternate_identifiers = [{ "alternateIdentifier" => meta["id"], "alternateIdentifierType" => "UUID" }]

  { "id" => id,
    "type" => type,
    "url" => url,
    "titles" => titles,
    "contributors" => contributors,
    "publisher" => publisher,
    "container" => container,
    "date" => date,
    "language" => language,
    "descriptions" => descriptions,
    "license" => license,
    "subjects" => subjects.presence,
    "references" => references.presence,
    "funding_references" => funding_references.presence,
    "related_identifiers" => related_identifiers.presence,
    "alternate_identifiers" => alternate_identifiers,
    "state" => state }.compact.merge(read_options)
end