swiftype-app-search 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2254f5b17c63dc6aad243e5b4a7e165cdfc7fd29f75ef20f3a7d8b46f57403
-  data.tar.gz: 4f5967113edc23e4d9b1a521d06e14c64e7cb69a37d57d6ef342b5003be70f2d
+  metadata.gz: 7ed5f865b5826a9e1f6ef4159e8666f40854d88507d5e385ade79843be1ec328
+  data.tar.gz: 8de8289db41e4b425c88890c7e9ec9d2347b6f234654c0813d9f79b51c40601c
 SHA512:
-  metadata.gz: ec871c6e1c1e798cb91e749cde14e86a7fdca6c119855fa84a23cf29a09962018ee4022849017450d201784dce32023e47fb4ebf83390cd63aea7ffdcbd2853d
-  data.tar.gz: f9a52b4a5d73328230c55498a9bef95b6045271ecf49ca29fe2b2b7eeea7c16be4a92efdccc98c8ad4f7aa68fb7c4e4a392657e8cf6dfd72aa3638464e569f6c
+  metadata.gz: 2fd5aafef38257cae51fc924825020cceb127c980d54c26e6011ee28a3b620d8143fa94e56d49de5fd9e646e3509f2242afbc425da220a013e040d6f6e2aa3f8
+  data.tar.gz: d78bda22152a9e4046582612c136a63bdd3a18daa0d1a305a847ac04a4f90b077a9805f17f7c638807fba3dd58702143b861fe29158a2032ec6a7c5cadc2c3da

data/.circleci/config.yml

@@ -0,0 +1,56 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/README.md

@@ -1,5 +1,7 @@
 # Ruby client for the Swiftype App Search API
 
+[![CircleCI](https://circleci.com/gh/swiftype/swiftype-app-search-ruby.svg?style=svg)](https://circleci.com/gh/swiftype/swiftype-app-search-ruby)
+
 ## Installation
 
 To install the gem, execute:

data/lib/swiftype-app-search/request.rb

@@ -6,7 +6,8 @@ require 'swiftype-app-search/version'
 require 'openssl'
 
 module SwiftypeAppSearch
-  DEFAULT_USER_AGENT = "swiftype-app-search-ruby/#{SwiftypeAppSearch::VERSION}"
+  CLIENT_NAME = 'swiftype-app-search-ruby'
+  CLIENT_VERSION = SwiftypeAppSearch::VERSION
 
   module Request
     attr_accessor :last_request
@@ -133,7 +134,8 @@ module SwiftypeAppSearch
       req = klass.new(uri.request_uri)
       req.body = serialize_json(params) unless params.length == 0
 
-      req['User-Agent'] = DEFAULT_USER_AGENT
+      req['X-Swiftype-Client'] = CLIENT_NAME
+      req['X-Swiftype-Client-Version'] = CLIENT_VERSION
       req['Content-Type'] = 'application/json'
       req['Authorization'] = "Bearer #{api_key}"
 

data/lib/swiftype-app-search/version.rb

@@ -1,3 +1,3 @@
 module SwiftypeAppSearch
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/client_spec.rb

@@ -1,9 +1,24 @@
+
 describe SwiftypeAppSearch::Client do
   let(:engine_name) { "ruby-client-test-#{Time.now.to_i}" }
 
   include_context "App Search Credentials"
   let(:client) { SwiftypeAppSearch::Client.new(client_options) }
 
+  describe 'Requests' do
+    it 'should include client name and version in headers' do
+      stub_request(:any, "#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
+      client.list_engines
+      expect(WebMock).to have_requested(:get, "https://#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines").
+        with(
+          headers: {
+            'X-Swiftype-Client' => 'swiftype-app-search-ruby',
+            'X-Swiftype-Client-Version' => SwiftypeAppSearch::VERSION
+          }
+        )
+    end
+  end
+
   context 'Documents' do
     let(:document) { { 'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE' } }
 

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
 require 'bundler/setup'
 require 'rspec'
-require 'webmock'
+require 'webmock/rspec'
 require 'awesome_print'
 require 'swiftype-app-search'
 
+WebMock.allow_net_connect!
+
 RSpec.shared_context "App Search Credentials" do
   let(:as_api_key) { ENV.fetch('AS_API_KEY', 'API_KEY') }
   # AS_ACCOUNT_HOST_KEY is deprecated

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"