Class: Refine

Inherits:
Object
  • Object
show all
Defined in:
lib/refine.rb,
lib/refine/version.rb

Defined Under Namespace

Classes: ProjectNotFound

Constant Summary collapse

VERSION = 
"0.3.4"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}, &block) ⇒ Refine

Returns a new instance of Refine.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/refine.rb', line 30

def initialize(opts = {}, &block)
  @http_client_config = block
  @server = opts["server"] || "http://127.0.0.1:3333"

   @throws_exceptions = opts["throws_exceptions"] === false ? false : true

  if opts["file_name"] && !opts["file_name"].empty? && opts["project_name"] && !opts["project_name"].empty?
    project_name = CGI.escape(opts["project_name"])
    @project_id = create_project(project_name, opts["file_name"])
    @project_name = project_name if @project_id
  else
    @project_id = opts["project_id"]

    metadata = self.get_project_metadata
    if metadata['status'] == 'error'
      raise ProjectNotFound.new(metadata['message'], project_id: @project_id, server: @server)
    else
      @project_name = CGI.escape(metadata["name"])
    end
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object 



217
218
219
220
 
# File 'lib/refine.rb', line 217

def method_missing(method, *args)
  # translate: get_column_info --> get-column-info

  call(method.to_s.gsub('_', '-'), *args)
end

Instance Attribute Details

#project_id ⇒ Object (readonly)

Returns the value of attribute project_id.



22
23
24
 
# File 'lib/refine.rb', line 22

def project_id
  @project_id
end

#project_name ⇒ Object (readonly)

Returns the value of attribute project_name.



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

def project_name
  @project_name
end

Class Method Details

.get_all_project_metadata(server = "http://127.0.0.1:3333") ⇒ Object 



24
25
26
27
28
 
# File 'lib/refine.rb', line 24

def self.get_all_project_metadata(server="http://127.0.0.1:3333")
  uri = "#{server}/command/core/get-all-project-metadata"
  response = HTTPClient.new().get(uri)
  JSON.parse(response.body)
end

Instance Method Details

#apply_operations(file_name_or_string) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/refine.rb', line 72

def apply_operations(file_name_or_string)
  if File.exist?(file_name_or_string)
    operations = File.read(file_name_or_string)
  else
    operations = file_name_or_string
  end

  call('apply-operations', 'operations' => operations)
end

#call(method, params = {}) ⇒ Object

this pattern is pulled from mailchimp/mailchimp-gem



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/refine.rb', line 111

def call(method, params = {})
  uri = "#{@server}/command/core/#{method}"
  params = { "project" => @project_id }.merge(params)

  response = if method.start_with?('get-')
    client.get(uri, params)
  else
    client.post(uri, params)
  end

  begin
    response = JSON.parse(response.body)
  rescue
    response = JSON.parse('[' + response.body + ']').first
  end

  if @throws_exceptions && response.is_a?(Hash) && response["code"] && response["code"] == "error"
    raise "API Error: #{response}"
  end

  response
end

#compute_facet(*column_names) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/refine.rb', line 147

def compute_facet(*column_names)

  formatted = column_names.map do |column|
    expression, sort_by, invert = facet_opts(column.values.first)
    {
      "columnName" => column.keys.first,
      "expression" => expression,
      "name" => column.keys.first,
      "invert" => invert,
      "sort" => sort_by,
      "selection" => []
    }
  end

  json_facet = JSON::dump(facets: formatted)

  openrefine_response = compute_facets("engine" => json_facet)

  openrefine_response.fetch("facets").map do |facet|

    if facet.key?("choices")

      choices_hash = facet.fetch("choices").map do |h|
        Hash[%w(value label count selected).zip([h["v"]["v"], h["v"]["l"], h["c"], h["s"]])]
      end

      Hash[%w(columnName name expression choices).zip([facet.fetch("columnName"), facet.fetch("name"), facet.fetch("expression"), choices_hash])]
    elsif facet.key?("error")

      Hash[%w(columnName name expression error).zip([facet.fetch("columnName"), facet.fetch("name"), facet.fetch("expression"), facet.fetch("error")])]
    end

  end

end

#create_project(project_name, file_name) ⇒ Object 



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

def create_project(project_name, file_name)
  uri = @server + "/command/core/create-project-from-upload"
  project_id = false
  File.open(file_name) do |file|
    body = {
      'project-file' => file,
      'project-name' => project_name
    }

    response = client.post(uri, body: body, header: {"Content-Type" => "multipart/form-data; charset=utf-8; boundary=#{create_boundary}"})

    url = response.header['Location']
    unless url == []
      project_id = CGI.parse(url[0].split('?')[1])['project'][0]
    end
  end
  raise "Error creating project: #{response}" unless project_id
  project_id
end

#delete_project ⇒ Object 



100
101
102
103
104
105
106
107
 
# File 'lib/refine.rb', line 100

def delete_project
  uri = @server + "/command/core/delete-project"
  body = {
    'project' => @project_id
  }
  @response = client.post(uri, body)
  JSON.parse(@response.content)['code'] rescue false
end

#export_rows(opts = {}) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/refine.rb', line 82

def export_rows(opts={})
  format = opts["format"] || 'tsv'
  uri = @server + "/command/core/export-rows/#{@project_name}.#{format}"

  body = {
    'engine' => {
      "facets" => opts["facets"] || [],
      "mode" => "row-based"
    }.to_json,
    'options' => opts["options"] || '',
    'project' => @project_id,
    'format' => format
  }

  @response = client.post(uri, body)
  @response.content
end

#facet_parameters(*column_names) ⇒ Object 



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
 
# File 'lib/refine.rb', line 183

def facet_parameters(*column_names)
  column_names.map do |column|
    case column when String then
    {
      "c" => {
        "columnName" => column,
        "expression"=>"value",
        "name"=> column,
        "invert"=> false
      },
      "o" => {
        "sort" => "name"
      }
    }
    when Hash
      expression, sort_by, invert = facet_opts(column.values.first)

        {
          "c" => {
            "columnName" => column.keys.first,
            "expression"=> expression,
            "name"=> column.keys.first,
            "invert" => invert
          },
          "o" => {
            "sort" => sort_by
          }
        }
    end
  end
end

#link_to_facets(*column_names) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/refine.rb', line 134

def link_to_facets(*column_names)
  uri = Addressable::URI.parse("#{@server}/project")

  facet = facet_parameters(*column_names)

  json_facet=JSON::dump(facets: facet).gsub(' ', "\t")

  uri.query = Addressable::URI::form_encode({project: @project_id, ui: json_facet})

  uri.to_s.gsub("%09", "%20")

end