Class: LicenseAuto::MavenCentralRepository

Inherits:
Object
  • Object
show all
Defined in:
lib/license_auto/website/maven_central_repository.rb

Constant Summary collapse

REST_API =

RESTful Sample GET search.maven.org/solrsearch/select?q=g%3A%22com.google.inject%22&rows=20&wt=json

'http://search.maven.org/solrsearch'

Instance Method Summary collapse

Constructor Details

#initialize(group_id, artifact_id, version, central_prefix = 'https://repo1.maven.org/maven2') ⇒ MavenCentralRepository

Returns a new instance of MavenCentralRepository.



18
19
20
21
22
23
24
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 18

def initialize(group_id, artifact_id, version, central_prefix='https://repo1.maven.org/maven2')
  @group_id = group_id
  @artifact_id = artifact_id
  @version = version
  @classifier = ''
  @central_prefix = central_prefix
end

Instance Method Details

#advance_search ⇒ Object

Eg: search.maven.org/solrsearch/select?q=g:%22com.google.inject%22%20AND%20a:%22guice%22%20AND%20v:%223.0%22%20AND%20l:%22javadoc%22%20AND%20p:%22jar%22&rows=20&wt=json



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 91

def advance_search
  url = "http://search.maven.org/solrsearch/select?q=g:\"#{@group_id}\" AND a:\"#{@artifact_id}\" AND v:\"#{@version}\" AND l:\"#{@classifier}\" AND p:\"jar\"&rows=20&wt=json"
  url = URI.escape(url)
  LicenseAuto.logger.debug("api_url: #{url}")
  response = HTTParty.get(url)
  if response.code == 200
    query_set = JSON.parse(response.body)
  else
    raise "CentralRepository select error: #{response}"
  end
end

#get_license_info ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 136

def get_license_info()
  license_info = LicenseAuto::LicenseInfoWrapper.new
  query_set = select

  if query_set.nil?
    LicenseAuto.logger.error("Maven search result is empty")
  else
    query_set.response.docs.each {|doc|
      if doc.v == @version && doc.ec.include?('.pom')
        pom_url, pom_str = get_package_pom(@group_id, @artifact_id, @version)
        if pom_str
          pack_wrapper, license_files = parser_pom(pom_url, pom_str)
          license_info[:pack] = pack_wrapper
          license_info[:licenses] = license_files
        end
        break
      end
    }
  end
  license_info
end

#get_package_pom(group, name, version) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 103

def get_package_pom(group, name, version)
  pom_url = make_pom_url(group, name, version)
  # http://stackoverflow.com/questions/25814210/opensslsslsslerror-ssl-connect-syscall-returned-5-errno-0-state-sslv3-read
  response = HTTParty.get(pom_url, :ssl_version => 'TLSv1')
  pom_str =
      if response.code == 200
        LicenseAuto.logger.debug("pom_url: #{pom_url}")
        response.body
      else
        LicenseAuto.logger.error("pom_url: #{pom_url}, #{response}")
      end
  [pom_url, pom_str]
end

#has_version ⇒ Object 



132
133
134
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 132

def has_version
  not @version.nil? and @version != ''
end

#make_pom_url(group, name, version) ⇒ Object

Example: repo1.maven.org/maven2/com/google/inject/guice/3.0/guice-3.0.pom



118
119
120
121
122
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 118

def make_pom_url(group, name, version)
  central_body = [group.gsub(/\./, '/'), name, version].join('/')
  central_tail = "#{name}-#{version}.pom"
  [@central_prefix, central_body, central_tail].join('/')
end

#make_project_url ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 124

def make_project_url
  if has_version
    "https://maven-repository.com/artifact/#{@group_id}/#{@artifact_id}/#{@version}"
  else
    "https://maven-repository.com/artifact/#{@group_id}/#{@artifact_id}"
  end
end

#parser_pom(pom_url, pom_str) ⇒ Object

Returns homepage, source_url, licenses_file.

Returns:

  • homepage, source_url, licenses_file



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 159

def parser_pom(pom_url, pom_str)
  LicenseAuto.logger.debug("pom_str:\n#{pom_str[0..70]}")
  doc = Nokogiri::XML(pom_str).remove_namespaces!

  # Source Code Manager
  scm_node = doc.xpath("/project/scm/url")
  source_url = if scm_node
                 scm_node.text
               end

  homepage_node = doc.xpath("/project/url")
  homepage = if homepage_node
               homepage_node.text
             end

  pack_wrapper = LicenseAuto::PackWrapper.new(
      project_url: make_project_url,
      homepage: homepage,
      source_url: source_url
  )

  licenses_node = doc.xpath("//licenses/license")
  LicenseAuto.logger.debug("licenses: \n#{licenses_node.to_xml}")

  # Multi licenses: https://maven-repository.com/artifact/org.cryptacular/cryptacular/1.0
  license_files = licenses_node.map {|node|
    license_name = if node.xpath(".//name")
                     node.xpath(".//name").text.gsub(/\s/, '')
                   end
    license_url = if node.xpath(".//url")
                    node.xpath(".//url").text
                  end

    # TODO: find a license_text demo
    license_text = if not node.xpath(".//text").empty?
                     LicenseAuto.logger.debug(node.xpath(".//text").text)
                     node.xpath(".//text").text
                   elsif not license_url.empty?
                     LicenseAuto.logger.debug(license_url)
                     # TODO: add proxy
                     response = HTTParty.get(license_url, timeout: 10)
                     response.body if response.code == 200
                   end

    _license_name, sim_ratio =
        if license_text
          LicenseAuto::Similarity.new(license_text).most_license_sim
        else
          [nil, 1.0]
        end

    if license_text.nil? and not node.xpath(".//comments").empty?
      LicenseAuto.logger.debug(node.xpath(".//comments").text)
      license_text = node.xpath(".//comments").text
    end

    LicenseAuto::LicenseWrapper.new(
        name: license_name,
        sim_ratio: sim_ratio,
        html_url: pom_url,
        download_url: license_url,
        text: license_text
    )
  }

  # Comment license text info: eg. https://repo1.maven.org/maven2/commons-io/commons-io/2.4/commons-io-2.4.pom
  if license_files.empty?
    comment_head_node = doc.xpath("/comment()[contains(., 'license')]")
    if comment_head_node.size > 0
      license_text = comment_head_node.to_xml
      license_files.push(
          LicenseAuto::LicenseWrapper.new(
              name: "UNKNOWN",
              sim_ratio: 1.0,
              html_url: pom_url,
              download_url: pom_url,
              text: license_text
          )
      )
    else
      author_head_node = doc.xpath("/comment()[contains(., 'author')]")
      if author_head_node.size > 0
        license_text = author_head_node.to_xml
        license_files.push(
            LicenseAuto::LicenseWrapper.new(
                name: "UNKNOWN",
                sim_ratio: 1.0,
                html_url: pom_url,
                download_url: pom_url,
                text: license_text
            )
        )
      end
    end
  end

  [pack_wrapper, license_files]
end

#select ⇒ Object

Example: GET search.maven.org/solrsearch/select?q=g:“com.google.inject”+AND+a:“guice”&core=gav&rows=20&wt=json @return:

{
    "responseHeader":{
        "status":0,
        "QTime":0,
        "params":{
            "fl":"id,g,a,v,p,ec,timestamp,tags",
            "sort":"score desc,timestamp desc,g asc,a asc,v desc",
            "indent":"off",
            "q":"g:\"net.sourceforge.nekohtml\" AND a:\"nekohtml\" AND v:\"1.9.20\"",
            "core":"gav",
            "wt":"json",
            "rows":"20",
            "version":"2.2"
        }
    },
    "response":{
        "numFound":1,
        "start":0,
        "docs":[
            {
                "id":"net.sourceforge.nekohtml:nekohtml:1.9.20",
                "g":"net.sourceforge.nekohtml",
                "a":"nekohtml",
                "v":"1.9.20",
                "p":"jar",
                "timestamp":1392301277000,
                "tags":[
                    "html",
                    "parser",
                    "balancer"
                ],
                "ec":[
                    "-sources.jar",
                    "-javadoc.jar",
                    ".jar",
                    ".pom"
                ]
            }
        ]
    }
}



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/license_auto/website/maven_central_repository.rb', line 70

def select()
  url =
      if has_version
        "#{REST_API}/select?q=g:\"#{@group_id}\"+AND+a:\"#{@artifact_id}\"+AND+v:\"#{@version}\"&core=gav&rows=20&wt=json"
      else
        "#{REST_API}/select?q=g:\"#{@group_id}\"+AND+a:\"#{@artifact_id}\"&core=gav&rows=20&wt=json"
      end

  url = URI.escape(url)
  response = HTTParty.get(url)
  if response.code == 200
    Hashie::Mash.new(JSON.parse(response.body))
  else
    error = "CentralRepository select error:\n#{response}"
    LicenseAuto.logger.debug(url)
    LicenseAuto.logger.error(error)
    nil
  end
end