gcr 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc8bcb870839377b9462083dd9bfba0799140c9c
-  data.tar.gz: e273d0e31fb034dd00d63805c81595352c69f011
+  metadata.gz: a287464e10ba8e1c1fe77848e417c197ab79ebfb
+  data.tar.gz: d4131657599c3008bc8ac4c8f7b3ebafc382b5c7
 SHA512:
-  metadata.gz: 51b729c8b9e0d87e4a85845dc4e7df93afa0264858703ad62bd946b96a307d7a739a10a5bc1f1fdcde7de915c58ce5cf32b745cc0b6d559fe2ed919c9e0c03b1
-  data.tar.gz: c6085701a5c4ffdb6cc5156429acf6f7b39d6708430c5acc6cd7165c1a845011ec83cdef167b4548837fd2a8299c6bad94b159b79447033b6819010064df1b7c
+  metadata.gz: 207d6bb496e0a10a095763fb454ddef54002c1121fb4699b629161971b638f31e7f5128d81964bb6cb5bbee2c356c48fa6f2fdd7da734b70e795c36abd613e8d
+  data.tar.gz: '09403d61c03c953b111f0429a5f0a380c4948637cdf0ef06fce73f24c5e6b6c6a403e5af89fca34b284551eadc4345289a12f1381c438f1e76a03099f8525c35'

data/lib/gcr.rb

@@ -1,9 +1,27 @@
+require "json"
+
 module GCR
   Error = Class.new(StandardError)
   ConfigError = Class.new(Error)
   RunningError = Class.new(Error)
   NoRecording = Class.new(Error)
 
+  # Ignore these fields when matching requests.
+  #
+  # *fields - String field names (eg. "token").
+  #
+  # Returns nothing.
+  def ignore(*fields)
+    ignored_fields.concat(fields.map(&:to_s))
+  end
+
+  # Fields that are ignored when matching requests.
+  #
+  # Returns an Array of Strings.
+  def ignored_fields
+    @ignored_fields ||= []
+  end
+
   # Specify where GCR should store cassettes.
   #
   # path - The String path to a directory.
@@ -75,29 +93,9 @@ module GCR
     @cassette = nil
   end
 
-  def serialize_request(route, req, marshal, unmarshal, metadata)
-    JSON.dump(
-      "route" => route,
-      "req"   => Base64.strict_encode64(req.to_proto)
-    )
-  end
-
-  def serialize_response(resp)
-    JSON.dump(
-      "type"  => resp.class.descriptor.name,
-      "buf" => Base64.strict_encode64(resp.to_proto)
-    )
-  end
-
-  def deserialize_response(str)
-    hsh = JSON.parse(str)
-    klass = Google::Protobuf::DescriptorPool.generated_pool.lookup(hsh["type"]).msgclass
-    klass.decode(Base64.strict_decode64(hsh["buf"]))
-  end
-
   extend self
 end
 
-require "json"
-require "base64"
 require "gcr/cassette"
+require "gcr/request"
+require "gcr/response"

data/lib/gcr/cassette.rb

@@ -1,5 +1,7 @@
 class GCR::Cassette
-  attr_reader :data
+  VERSION = 2
+
+  attr_reader :reqs
 
   # Delete all recorded cassettes.
   #
@@ -17,7 +19,7 @@ class GCR::Cassette
   # Returns nothing.
   def initialize(name)
     @path = File.join(GCR.cassette_dir, "#{name}.json")
-    @data = {}
+    @reqs = []
   end
 
   # Does this cassette exist?
@@ -31,7 +33,15 @@ class GCR::Cassette
   #
   # Returns nothing.
   def load
-    @data = JSON.parse(File.read(@path))
+    data = JSON.parse(File.read(@path))
+
+    if data["version"] != VERSION
+      raise "GCR cassette version #{data["version"]} not supported"
+    end
+
+    @reqs = data["reqs"].map do |req, resp|
+      [GCR::Request.from_hash(req), GCR::Response.from_hash(resp)]
+    end
   end
 
   # Persist this cassette.
@@ -39,7 +49,10 @@ class GCR::Cassette
   # Returns nothing.
   def save
     File.open(@path, "w") do |f|
-      f.write(JSON.pretty_generate(data))
+      f.write(JSON.pretty_generate(
+        "version" => VERSION,
+        "reqs"    => reqs,
+      ))
     end
   end
 
@@ -69,8 +82,10 @@ class GCR::Cassette
 
       def request_response(*args)
         orig_request_response(*args).tap do |resp|
-          key = GCR.serialize_request(*args)
-          GCR.cassette.data[key] ||= GCR.serialize_response(resp)
+          req = GCR::Request.from_proto(*args)
+          if GCR.cassette.reqs.none? { |r, _| r == req }
+            GCR.cassette.reqs << [req, GCR::Response.from_proto(resp)]
+          end
         end
       end
     end
@@ -90,12 +105,11 @@ class GCR::Cassette
       alias_method :orig_request_response, :request_response
 
       def request_response(*args)
-        key = GCR.serialize_request(*args)
-        if resp = GCR.cassette.data[key]
-          GCR.deserialize_response(resp)
-        else
-          raise GCR::NoRecording
+        req = GCR::Request.from_proto(*args)
+        GCR.cassette.reqs.each do |other_req, resp|
+          return resp.to_proto if req == other_req
         end
+        raise GCR::NoRecording
       end
     end
   end
@@ -105,4 +119,12 @@ class GCR::Cassette
       alias_method :request_response, :orig_request_response
     end
   end
+
+  def [](req)
+    reqs.find { |r| r == req }
+  end
+
+  def []=(req, resp)
+    reqs << [req, resp]
+  end
 end

data/lib/gcr/request.rb

@@ -0,0 +1,47 @@
+class GCR::Request
+  def self.from_proto(route, proto_req, *_)
+    new(
+      "route"      => route,
+      "class_name" => proto_req.class.name,
+      "body"       => proto_req.to_json,
+    )
+  end
+
+  def self.from_hash(hash_req)
+    new(
+      "route"      => hash_req["route"],
+      "class_name" => hash_req["class_name"],
+      "body"       => hash_req["body"],
+    )
+  end
+
+  attr_reader :route, :class_name, :body
+
+  def initialize(opts)
+    @route      = opts["route"]
+    @class_name = opts["class_name"]
+    @body       = opts["body"]
+  end
+
+  def parsed_body
+    @parsed_body ||= JSON.parse(body)
+  end
+
+  def to_json(*_)
+    JSON.dump("route" => route, "class_name" => class_name, "body" => body)
+  end
+
+  def to_proto
+    [route, Object.const_get(class_name).decode_json(body)]
+  end
+
+  def ==(other)
+    return false unless route == other.route
+    return false unless class_name == other.class_name
+
+    parsed_body.keys.all? do |k|
+      next true if GCR.ignored_fields.include?(k)
+      parsed_body[k] == other.parsed_body[k]
+    end
+  end
+end

data/lib/gcr/response.rb

@@ -0,0 +1,34 @@
+class GCR::Response
+  def self.from_proto(proto_resp)
+    new(
+      "class_name" => proto_resp.class.name,
+      "body"       => proto_resp.to_json,
+    )
+  end
+
+  def self.from_hash(hash_resp)
+    new(
+      "class_name" => hash_resp["class_name"],
+      "body"       => hash_resp["body"],
+    )
+  end
+
+  attr_reader :class_name, :body
+
+  def initialize(opts)
+    @class_name = opts["class_name"]
+    @body = opts["body"]
+  end
+
+  def parsed_body
+    @parsed_body ||= JSON.decode(body)
+  end
+
+  def to_json(*_)
+    JSON.dump("class_name" => class_name, "body" => body)
+  end
+
+  def to_proto
+    Object.const_get(class_name).decode_json(body)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gcr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - mastahyeti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -84,6 +84,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -92,6 +106,8 @@ extra_rdoc_files: []
 files:
 - "./lib/gcr.rb"
 - "./lib/gcr/cassette.rb"
+- "./lib/gcr/request.rb"
+- "./lib/gcr/response.rb"
 homepage: https://github.com/mastahyeti/gcr
 licenses:
 - MIT
@@ -112,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: GRPC test helpers