lhc 3.6.1 → 3.7.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ca2e1026c3f06a4352d9dbe01bfe2c43b37ae80
-  data.tar.gz: cee1ead64c10ddb0148657cbb5aa195eb87cab1b
+  metadata.gz: 9ba7b312631cdd807ba15789447528102d6c6c65
+  data.tar.gz: 7ac5531c6deecaa7a9ec73c9422443acffdcffd8
 SHA512:
-  metadata.gz: 5e439fc2091bdca5ee4a9f3f3ef984e4dcefefa508366cf613300b12c1f53a2308e72f018b15403de09cf33c34b6a11a50eb13b9d140a4fda484182269070ebe
-  data.tar.gz: cc8281cbc6e3440bc77113626ae9526e1ba30be0fefd6a547a282440ceb4dae14d1e7e766c5a2d1a6ed8c32728c02b4ab87d9efc6320e5d7fc5356ecbfd2923d
+  metadata.gz: ccb2e358ec64e1a396e6e05b1e024a0af8d846bf579e78ff01bc42d69f1877de713594386cd33cfda97ad2b17d7ffa9a936d5903f67c585a1d97cd4e04e48e6c
+  data.tar.gz: 524a3e8fc64058a97594ff4b5ebd3bf80e4e2853a3bd24288c3a7970f345f08c6d0f80863722c62457875608b6ea048daa05f8acaffaf4caa38c64284148bc32

data/README.md

@@ -45,6 +45,18 @@ Currently supported formats: `json`
 
 → [Read more about the response object](docs/response.md)
 
+## Accessing data
+
+The response data can be access with dot-notation and square-bracket notation. You can convert response data to open structs or json (if the response format is json).
+
+```ruby
+  response = LHC.request(url: 'http://datastore/entry/1')
+  response.data.as_open_struct #<OpenStruct name='local.ch'>
+  response.data.as_json # { name: 'local.ch' }
+  response.data.name # 'local.ch'
+  response.data[:name] # 'local.ch'
+```
+
 ## Parallel requests
 
 If you pass an array of requests to `LHC.request`, it will perform those requests in parallel.

data/lib/lhc/formats/json.rb

@@ -9,10 +9,12 @@ class JsonFormat
     super(options)
   end
 
-  def parse(response)
-    JSON.parse(response.body, object_class: OpenStruct)
-  rescue JSON::ParserError => e
-    raise LHC::ParserError.new(e.message, response)
+  def as_json(response)
+    parse(response, Hash)
+  end
+
+  def as_open_struct(response)
+    parse(response, OpenStruct)
   end
 
   def to_s
@@ -22,4 +24,12 @@ class JsonFormat
   def to_sym
     to_s.to_sym
   end
+
+  private
+
+  def parse(response, object_class)
+    JSON.parse(response.body, object_class: object_class)
+  rescue JSON::ParserError => e
+    raise LHC::ParserError.new(e.message, response)
+  end
 end

data/lib/lhc/response.rb

@@ -13,11 +13,8 @@ class LHC::Response
     self.raw = raw
   end
 
-  # Access response data.
-  # Cache parsing.
   def data
-    @data ||= format.parse(self)
-    @data
+    @data ||= LHC::Response::Data.new(self)
   end
 
   def effective_url
@@ -53,13 +50,13 @@ class LHC::Response
     raw.success?
   end
 
-  private
-
-  attr_accessor :raw
-
   def format
     return JsonFormat.new if request.nil?
     request.format
   end
 
+  private
+
+  attr_accessor :raw
+
 end

data/lib/lhc/response/data.rb

@@ -0,0 +1,34 @@
+# Response data is data provided through the response body
+# but made accssible in the ruby world
+class LHC::Response::Data
+
+  def initialize(response)
+    @response = response
+    set_dynamic_accessor_methods
+  end
+
+  def as_json
+    response.format.as_json(response)
+  end
+
+  def as_open_struct
+    response.format.as_open_struct(response)
+  end
+
+  def [](key)
+    @hash ||= as_json.with_indifferent_access
+    @hash[key]
+  end
+
+  private
+
+  attr_reader :response
+
+  def set_dynamic_accessor_methods
+    as_json.keys.each do |key|
+      define_singleton_method key do |*args|
+        as_open_struct.send key, *args
+      end
+    end
+  end
+end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION = "3.6.1"
+  VERSION = "3.7.0.pre1"
 end

data/spec/response/data_spec.rb

@@ -8,9 +8,22 @@ describe LHC::Response do
 
     let(:raw_response) { OpenStruct.new(body: body.to_json) }
 
+    let(:response) { LHC::Response.new(raw_response, nil) }
+
     it 'makes data from response body available' do
-      response = LHC::Response.new(raw_response, nil)
       expect(response.data.some_key.nested).to eq value
     end
+
+    it 'makes data from response body available with hash bracket notation' do
+      expect(response.data[:some_key][:nested]).to eq value
+    end
+
+    it 'can be converted to json with the as_json method' do
+      expect(response.data.as_json).to eq body.as_json
+    end
+
+    it 'can be converted to an open struct with the as_open_struct method' do
+      expect(response.data.as_open_struct).to eq JSON.parse(response.body, object_class: OpenStruct)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.0.pre1
 platform: ruby
 authors:
 - local.ch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -167,6 +167,7 @@ files:
 - lib/lhc/interceptor_processor.rb
 - lib/lhc/request.rb
 - lib/lhc/response.rb
+- lib/lhc/response/data.rb
 - lib/lhc/version.rb
 - non_rails_spec/request/request_spec.rb
 - script/ci/build.sh
@@ -271,9 +272,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - Ruby >= 1.9.2
 rubyforge_project: