Class: Mvp::Forge

Inherits:
Object
  • Object
show all
Defined in:
lib/mvp/forge.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Forge

Returns a new instance of Forge.



8
9
10
11
 
# File 'lib/mvp/forge.rb', line 8

def initialize(options = {})
  @useragent = 'Puppet Community Stats Monitor'
  @forgeapi  = options[:forgeapi] ||'https://forgeapi.puppet.com'
end

Instance Method Details

#flatten_modules(data) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mvp/forge.rb', line 94

def flatten_modules(data)
  data.each do |row|
    row['owner']             = row['owner']['username']
    row['superseded_by']     = row['superseded_by']['slug'] rescue nil
    row['pdk']               = row['current_release']['pdk']
    row['supported']         = row['current_release']['supported']
    row['version']           = row['current_release']['version']
    row['validation_score']  = row['current_release']['validation_score']
    row['license']           = row['current_release']['metadata']['license']
    row['source']            = row['current_release']['metadata']['source']
    row['project_page']      = row['current_release']['metadata']['project_page']
    row['issues_url']        = row['current_release']['metadata']['issues_url']
    row['tasks']             = row['current_release']['tasks'].map{|task| task['name']} rescue []

    row['release_count']     = row['releases'].count rescue 0
    row['releases']          = row['releases'].map{|r| r['version']} rescue []

    simplify_metadata(row, row['current_release']['metadata'])
    row.delete('current_release')
  end
  data
end

#flatten_releases(data) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/mvp/forge.rb', line 117

def flatten_releases(data)
  data.each do |row|
    row['name']              = row['module']['name']
    row['owner']             = row['module']['owner']['username']
    row['license']           = row['metadata']['license']
    row['source']            = row['metadata']['source']
    row['project_page']      = row['metadata']['project_page']
    row['issues_url']        = row['metadata']['issues_url']
    row['tasks']             = row['tasks'].map{|task| task['name']} rescue []

    simplify_metadata(row, row['metadata'])
    row.delete('module')
  end
  data
end

#flatten_validations(name, scores) ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/mvp/forge.rb', line 133

def flatten_validations(name, scores)
  row = { 'name' => name }
  scores.each do |entry|
    row[entry['name']] = entry['score']
  end
  row
end

#munge_dates(object) ⇒ Object

transform dates into a format that bigquery knows



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mvp/forge.rb', line 82

def munge_dates(object)
  ["created_at", "updated_at", "deprecated_at", "deleted_at"].each do |field|
    next unless object.first.keys.include? field

    object.each do |record|
      next unless record[field]
      record[field] = DateTime.parse(record[field]).strftime("%Y-%m-%d %H:%M:%S")
    end
  end
  object
end

#retrieve(entity) ⇒ Object 



13
14
15
16
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
 
# File 'lib/mvp/forge.rb', line 13

def retrieve(entity)
  raise 'Please process downloaded data by passing a block' unless block_given?

  # using authors for git repo terminology consistency
  entity = :users if entity == :authors
  begin
    offset   = 0
    endpoint = "/v3/#{entity}?sort_by=downloads&limit=50"

    while endpoint do
      response = HTTParty.get("#{@forgeapi}#{endpoint}", headers: {"User-Agent" => @useragent})
      raise "Forge Error: #{@response.body}" unless response.code == 200
      data    = JSON.parse(response.body)
      results = munge_dates(data['results'])

      case entity
      when :modules
        results = flatten_modules(results)
      when :releases
        results = flatten_releases(results)
      end

      yield results, offset

      offset  += 50
      endpoint = data['pagination']['next']
      if (endpoint and (offset % 250 == 0))
        GC.start
      end
    end

  rescue => e
    $logger.error e.message
    $logger.debug e.backtrace.join("\n")
  end

  nil
end

#retrieve_validations(modules, period = 25) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/mvp/forge.rb', line 52

def retrieve_validations(modules, period = 25)
  raise 'Please process validations by passing a block' unless block_given?

  offset = 0
  begin
    modules.each_slice(period) do |group|
      offset += period
      results = group.map { |mod| validations(mod[:slug]) }

      yield results, offset
      GC.start
    end
  rescue => e
    $logger.error e.message
    $logger.debug e.backtrace.join("\n")
  end

  nil
end

#simplify_metadata(data, metadata) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mvp/forge.rb', line 141

def simplify_metadata(data, metadata)
  data['operatingsystem']   = metadata['operatingsystem_support'].map{|i| i['operatingsystem']}                       rescue []
  data['dependencies']      = metadata['dependencies'].map{|i| i['name'].sub('/', '-')}                               rescue []
  data['puppet_range']      = metadata['requirements'].select{|r| r['name'] == 'puppet'}.first['version_requirement'] rescue nil
  data['metadata']          = metadata.to_json

  if data['puppet_range']
    range = SemanticPuppet::VersionRange.parse(data['puppet_range'])
    data['puppet_2x']       = range.include? SemanticPuppet::Version.parse('2.99.99')
    data['puppet_3x']       = range.include? SemanticPuppet::Version.parse('3.99.99')
    data['puppet_4x']       = range.include? SemanticPuppet::Version.parse('4.99.99')
    data['puppet_5x']       = range.include? SemanticPuppet::Version.parse('5.99.99')
    data['puppet_6x']       = range.include? SemanticPuppet::Version.parse('6.99.99')
    data['puppet_99x']      = range.include? SemanticPuppet::Version.parse('99.99.99')  # identify unbounded ranges
  end
end

#test ⇒ Object 



158
159
160
161
 
# File 'lib/mvp/forge.rb', line 158

def test()
  require 'pry'
  binding.pry
end

#validations(name) ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/mvp/forge.rb', line 72

def validations(name)
  endpoint = "/private/validations/"
  response = HTTParty.get("#{@forgeapi}#{endpoint}#{name}", headers: {'User-Agent' => @useragent})
  raise "Forge Error: #{@response.body}" unless response.code == 200

  flatten_validations(name, JSON.parse(response.body))
end