Class: OrcidClient::Work

Inherits:
Object
  • Object
show all
Includes:
Api, Author, Base, Date, Metadata, WorkType
Defined in:
lib/orcid_client/work.rb

Constant Summary collapse

SCHEMA = 
File.expand_path("../../../resources/record_#{API_VERSION}/work-#{API_VERSION}.xsd", __FILE__)

Constants included from Api

Api::API_VERSION

Constants included from WorkType

OrcidClient::WorkType::TYPE_OF_WORK

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Api

#create_external_identifier, #create_notification, #create_work, #delete_external_identifier, #delete_notification, #delete_work, #get_notification, #get_notification_access_token, #get_works, #update_work

Methods included from WorkType

#orcid_work_type

Methods included from Date

#get_date_parts, #get_date_parts_from_parts, #get_iso8601_from_epoch, #get_iso8601_from_time, #get_parts_from_date_parts, #get_year_month, #get_year_month_day

Methods included from Author

#get_authors, #get_credit_name, #get_full_name, #get_hashed_authors, #get_name_identifier, #get_one_author, #get_one_hashed_author

Methods included from Metadata

#get_crossref_metadata, #get_datacite_metadata, #get_doi_ra, #get_metadata, #get_orcid_metadata

Constructor Details

#initialize(doi:, orcid:, access_token:, **options) ⇒ Work

Returns a new instance of Work.



23
24
25
26
27
28
 
# File 'lib/orcid_client/work.rb', line 23

def initialize(doi:, orcid:, access_token:, **options)
  @doi = doi
  @orcid = orcid
  @access_token = access_token
  @put_code = options.fetch(:put_code, nil)
end

Instance Attribute Details

#access_token ⇒ Object (readonly)

Returns the value of attribute access_token.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def access_token
  @access_token
end

#doi ⇒ Object (readonly)

Returns the value of attribute doi.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def doi
  @doi
end

#orcid ⇒ Object (readonly)

Returns the value of attribute orcid.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def orcid
  @orcid
end

#put_code ⇒ Object (readonly)

Returns the value of attribute put_code.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def put_code
  @put_code
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def schema
  @schema
end

#validation_errors ⇒ Object (readonly)

Returns the value of attribute validation_errors.



21
22
23
 
# File 'lib/orcid_client/work.rb', line 21

def validation_errors
  @validation_errors
end

Instance Method Details

#author_string ⇒ Object 



44
45
46
47
48
 
# File 'lib/orcid_client/work.rb', line 44

def author_string
  Array(metadata.fetch('author', nil)).map do |contributor|
    get_full_name(contributor)
  end.join(" and ")
end

#container_title ⇒ Object 



58
59
60
 
# File 'lib/orcid_client/work.rb', line 58

def container_title
  metadata.fetch('container-title', nil)
end

#contributors ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/orcid_client/work.rb', line 36

def contributors
  Array(metadata.fetch('author', nil)).map do |contributor|
    { orcid: contributor.fetch('ORCID', nil),
      credit_name: get_credit_name(contributor),
      role: nil }.compact
  end
end

#data ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/orcid_client/work.rb', line 82

def data
  return nil unless has_required_elements?

  Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
    xml.send(:'work:work', root_attributes) do
      insert_work(xml)
    end
  end.to_xml
end

#description ⇒ Object 



70
71
72
 
# File 'lib/orcid_client/work.rb', line 70

def description
  sanitize(Array(metadata.fetch('description', nil)).first)
end

#has_required_elements? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/orcid_client/work.rb', line 78

def has_required_elements?
  doi && contributors && title && container_title && publication_date
end

#insert_contributor(xml, contributor) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/orcid_client/work.rb', line 157

def insert_contributor(xml, contributor)
  if contributor[:orcid].present?
    xml.send(:'common:contributor-orcid') do
      xml.send(:'common:uri', contributor[:orcid])
      xml.send(:'common:path', contributor[:orcid][17..-1])
      xml.send(:'common:host', 'orcid.org')
    end
  end
  xml.send(:'credit-name', contributor[:credit_name])
  if contributor[:role]
    xml.send(:'contributor-attributes') do
      xml.send(:'contributor-role', contributor[:role])
    end
  end
end

#insert_contributors(xml) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/orcid_client/work.rb', line 145

def insert_contributors(xml)
  return nil unless contributors.present?

  xml.send(:'work:contributors') do
    contributors.each do |contributor|
      xml.contributor do
        insert_contributor(xml, contributor)
      end
    end
  end
end

#insert_description(xml) ⇒ Object 



111
112
113
114
115
 
# File 'lib/orcid_client/work.rb', line 111

def insert_description(xml)
  return nil unless description.present?

  xml.send(:'work:short-description', description.truncate(2500, separator: ' '))
end

#insert_id(xml, id_type, value, relationship) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/orcid_client/work.rb', line 137

def insert_id(xml, id_type, value, relationship)
  xml.send(:'common:external-id') do
    xml.send(:'common:external-id-type', id_type)
    xml.send(:'common:external-id-value', value)
    xml.send(:'common:external-id-relationship', relationship)
  end
end

#insert_ids(xml) ⇒ Object 



131
132
133
134
135
 
# File 'lib/orcid_client/work.rb', line 131

def insert_ids(xml)
  xml.send(:'common:external-ids') do
    insert_id(xml, 'doi', doi, 'self')
  end
end

#insert_pub_date(xml) ⇒ Object 



121
122
123
124
125
126
127
128
129
 
# File 'lib/orcid_client/work.rb', line 121

def insert_pub_date(xml)
  if publication_date['year']
    xml.send(:'common:publication-date') do
      xml.year(publication_date.fetch('year'))
      xml.month(publication_date.fetch('month', nil)) if publication_date['month']
      xml.day(publication_date.fetch('day', nil)) if publication_date['month'] && publication_date['day']
    end
  end
end

#insert_titles(xml) ⇒ Object 



101
102
103
104
105
106
107
108
109
 
# File 'lib/orcid_client/work.rb', line 101

def insert_titles(xml)
  if title
    xml.send(:'work:title') do
      xml.send(:'common:title', title)
    end
  end

  xml.send(:'work:journal-title', container_title) if container_title
end

#insert_type(xml) ⇒ Object 



117
118
119
 
# File 'lib/orcid_client/work.rb', line 117

def insert_type(xml)
  xml.send(:'work:type', type)
end

#insert_work(xml) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/orcid_client/work.rb', line 92

def insert_work(xml)
  insert_titles(xml)
  insert_description(xml)
  insert_type(xml)
  insert_pub_date(xml)
  insert_ids(xml)
  insert_contributors(xml)
end

#metadata ⇒ Object 



32
33
34
 
# File 'lib/orcid_client/work.rb', line 32

def metadata
  @metadata ||= get_metadata(doi, 'datacite')
end

#publication_date ⇒ Object 



66
67
68
 
# File 'lib/orcid_client/work.rb', line 66

def publication_date
  get_year_month_day(metadata.fetch('published', nil))
end

#publisher_id ⇒ Object 



62
63
64
 
# File 'lib/orcid_client/work.rb', line 62

def publisher_id
  metadata.fetch('publisher_id', nil)
end

#root_attributes ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'lib/orcid_client/work.rb', line 183

def root_attributes
  { :'put-code' => put_code,
    :'visibility' => 'public',
    :'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
    :'xsi:schemaLocation' => 'http://www.orcid.org/ns/work ../work-2.0_rc3.xsd',
    :'xmlns:common' => 'http://www.orcid.org/ns/common',
    :'xmlns:work' => 'http://www.orcid.org/ns/work' }.compact
end

#sanitize(string) ⇒ Object 



50
51
52
 
# File 'lib/orcid_client/work.rb', line 50

def sanitize(string)
  Sanitize.fragment(string).squish
end

#title ⇒ Object 



54
55
56
 
# File 'lib/orcid_client/work.rb', line 54

def title
  metadata.fetch('title', nil)
end

#type ⇒ Object 



74
75
76
 
# File 'lib/orcid_client/work.rb', line 74

def type
  orcid_work_type(metadata.fetch('type', nil), metadata.fetch('subtype', nil))
end

#without_control(s) ⇒ Object 



173
174
175
176
177
178
179
180
181
 
# File 'lib/orcid_client/work.rb', line 173

def without_control(s)
  r = ''
  s.each_codepoint do |c|
    if c >= 32
      r << c
    end
  end
  r
end