Class: OpenGraphIO

Inherits:
Object
  • Object
show all
Defined in:
lib/opengraph-io.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ OpenGraphIO

Returns a new instance of OpenGraphIO.

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/opengraph-io.rb', line 10

def initialize(options)
  # Throw an error if app_id is not present in options hash
  raise ArgumentError.new(
    'app_id must be supplied when making requests to the API. '\
    'Get a free app_id by signing up here: https://www.opengraph.io/'
  ) unless options.has_key?(:app_id)

  @app_id = options[:app_id]

  # Assign options if present, or defaults if not
  # These can be overridden when making requests through OpenGraphIO#get_site_info
  @cache_ok =
    options.has_key?(:cache_ok) ?
      options[:cache_ok] :
      true
  @full_render =
    options.has_key?(:full_render) ?
      options[:full_render] :
      false
  @version =
    options.has_key?(:version) ?
      options[:version] :
      '1.1'
end

Instance Attribute Details

#app_id ⇒ Object

Returns the value of attribute app_id.



7
8
9
 
# File 'lib/opengraph-io.rb', line 7

def app_id
  @app_id
end

#cache_ok ⇒ Object

Returns the value of attribute cache_ok.



7
8
9
 
# File 'lib/opengraph-io.rb', line 7

def cache_ok
  @cache_ok
end

#full_render ⇒ Object

Returns the value of attribute full_render.



7
8
9
 
# File 'lib/opengraph-io.rb', line 7

def full_render
  @full_render
end

#version ⇒ Object

Returns the value of attribute version.



7
8
9
 
# File 'lib/opengraph-io.rb', line 7

def version
  @version
end

Instance Method Details

#get_site_info(passed_url, options = {}) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/opengraph-io.rb', line 65

def get_site_info(passed_url, options = {})
  uri = URI(get_site_info_url(passed_url))
  uri.query = URI.encode_www_form(get_site_info_query_params(options))
  response = Net::HTTP.get(uri)
  parsed = JSON.parse(response)
end

#get_site_info_query_params(options) ⇒ Object 



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
 
# File 'lib/opengraph-io.rb', line 39

def get_site_info_query_params(options)
  query_string_values = {}

  query_string_values[:app_id] = 
    options.has_key?(:app_id) ?
      options[:app_id] :
      @app_id

  query_string_values[:cache_ok] =
    options.has_key?(:cache_ok) ?
      options[:cache_ok] :
      @cache_ok

  query_string_values[:full_render] =
    options.has_key?(:full_render) ?
      options[:full_render] :
      @full_render

  query_string_values[:version] =
    options.has_key?(:version) ?
      options[:version] :
      @version

  query_string_values
end

#get_site_info_url(url) ⇒ Object 



35
36
37
 
# File 'lib/opengraph-io.rb', line 35

def get_site_info_url(url)
  'https://opengraph.io/api/' + @version + '/site/' + CGI.escape(url)
end