Module: ButterCMS

Defined in:
lib/buttercms/tag.rb,
lib/buttercms-ruby.rb,
lib/buttercms/feed.rb,
lib/buttercms/page.rb,
lib/buttercms/post.rb,
lib/buttercms/author.rb,
lib/buttercms/errors.rb,
lib/buttercms/content.rb,
lib/buttercms/version.rb,
lib/buttercms/category.rb,
lib/buttercms/hash_to_object.rb,
lib/buttercms/butter_resource.rb,
lib/buttercms/butter_collection.rb,
lib/buttercms/data_store_adapters/yaml.rb,
lib/buttercms/data_store_adapters/redis.rb

Defined Under Namespace

Modules: DataStoreAdapters Classes: Author, ButterCollection, ButterResource, Category, Content, Error, Feed, HashToObject, NotFound, Page, Post, Tag

Constant Summary collapse

VERSION = 
'1.3.2'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_token ⇒ Object

Returns the value of attribute api_token.



29
30
31
 
# File 'lib/buttercms-ruby.rb', line 29

def api_token
  @api_token
end

.data_store ⇒ Object

Returns the value of attribute data_store.



32
33
34
 
# File 'lib/buttercms-ruby.rb', line 32

def data_store
  @data_store
end

.logger ⇒ Object 



36
37
38
39
40
 
# File 'lib/buttercms-ruby.rb', line 36

def self.logger
  @logger ||= Logger.new($stdout).tap do |log|
    log.progname = "ButterCMS"
  end
end

.read_timeout ⇒ Object

Returns the value of attribute read_timeout.



31
32
33
 
# File 'lib/buttercms-ruby.rb', line 31

def read_timeout
  @read_timeout
end

.test_mode ⇒ Object

Returns the value of attribute test_mode.



30
31
32
 
# File 'lib/buttercms-ruby.rb', line 30

def test_mode
  @test_mode
end

Class Method Details

.api_request(path, options = {}) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/buttercms-ruby.rb', line 64

def self.api_request(path, options = {})
  query = options.dup
  query[:auth_token] ||= api_token

  if test_mode
    query[:test] = 1
  end

  path = "#{@api_url.path}#{URI.encode(path)}?#{URI.encode_www_form(query)}"

  http_options = {
    open_timeout: 2.0,
    read_timeout: read_timeout || 5.0,
    ssl_timeout:  2.0,
    use_ssl:      @api_url.scheme == "https",
  }

  response =
    Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
      request = Net::HTTP::Get.new(path)
      request["User-Agent"] = "ButterCMS/Ruby #{ButterCMS::VERSION}"
      request["Accept"]     = "application/json"

      http.request(request)
    end

  case response
  when Net::HTTPNotFound
    raise ::ButterCMS::NotFound, JSON.parse(response.body)["detail"]
  end

  response.body
end

.request(path, options = {}) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/buttercms-ruby.rb', line 98

def self.request(path, options = {})
  raise ArgumentError.new "Please set your API token" unless api_token

  key = "buttercms:#{path}:#{options}"

  begin
    result = api_request(path, options)

    if data_store
      data_store.set(key, result)
      logger.info "Set key #{key}"
    end

  # TODO - more selective exception handling (SocketError)
  rescue Exception => e

    if data_store
      if result = data_store.get(key)
        logger.info "Fetched key #{key}"

        # Log request error
        logger.error e
      else
        logger.info "No data for key #{key}"
      end
    end

    # Raise request exception if there's no data store or value returned
    raise e unless data_store && result
  end

  return JSON.parse(result)
end