embark-journey 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e479a384c70a25dae3045201d6aa4ca7bdbc2cbc
-  data.tar.gz: c41a09cfab41b72a5cde48002be0e73afedee615
+  metadata.gz: 35aff83caf7592c8490abbe897b29447acf19537
+  data.tar.gz: 82df81ae9c69ddc1aa89d5c2a95c6de7dfb88276
 SHA512:
-  metadata.gz: 15e5882c91e38f6b5289bd0b4ca7ef021d8811eee5a55293d4c7142856b62e2a120727814c0a2a791d1fbe3bc7e0da69486398b016aec4698b64de8859a5388a
-  data.tar.gz: 735730f502bb4c33c653c70f0f5ef22cae41f7b8e3d8ae7f3280aafd8919bcd37347064bd2390b9e58f4e61689950e1a3997247555ffa93ea3e6e3a19ce1fef6
+  metadata.gz: b8824778c4eb70721bfb8bdcf90acc70ba5a8af8a90e9b1eaa887131cbc4f136c69002e8936c8bcacc179c11f9d435922dd5d429dcdaf4b887b570c53c30b12b
+  data.tar.gz: f1405aeaf8bf87e16bd7483519f61720de0613f4551aae2d818374d4099170be1f2898db701bbd0d70bb19f2fff8e1261848ff983908f77deeea8b2d3972c0af

data/README.md

@@ -1,12 +1,12 @@
 # Journey
 
-TODO: Write a gem description
+A ruby wrapper for the Journey API. http://resources.journeyapps.com/api
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'journey'
+    gem 'embark-journey', require: 'journey'
 
 And then execute:
 
@@ -14,11 +14,31 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install journey
+    $ gem install embark-journey
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure Journey to use the relevant API credentials. For Rails, this would be placed in an initializer.
+
+    Journey.configure do |c|
+      c.api_site = ENV['JOURNEY_API_ENDPOINT']
+      c.api_user = ENV['JOURNEY_API_USERNAME']
+      c.api_password = ENV['JOURNEY_API_KEY']
+    end
+
+
+Create your resource models, inheriting from `Journey::Resource`. Under the hood, resources extend `ActiveResource::Base`. 
+
+    class User < Journey::Resource
+      schema do
+        string :name
+        datetime :last_login
+        string :state
+      end
+
+      enum :state, %w[Active Inactive]
+    end
+
 
 ## Contributing
 

data/journey.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.1.1'
   spec.add_development_dependency 'rspec', '~> 3.0.0.beta1'
+  spec.add_development_dependency 'factory_girl', '~> 4.3.0'
   spec.add_development_dependency 'dotenv', '~> 0.9.0'
   spec.add_development_dependency 'pry', '~> 0.9.12.4'
 

data/lib/journey/resource.rb

@@ -8,12 +8,14 @@ require 'journey/resource/api'
 require 'journey/resource/attribute_loading'
 require 'journey/resource/enums'
 require 'journey/resource/queries'
+require 'journey/resource/search'
 
 class Journey::Resource
   include API
   include Queries
   include Enums
   include AttributeLoading
+  include Search
 end
 
 

data/lib/journey/resource/search.rb

@@ -0,0 +1,12 @@
+require 'active_support/concern'
+
+module Journey::Resource::Search
+  extend ActiveSupport::Concern
+
+  included do
+    def self.search(q)
+      instantiate_collection format.decode(post(:search, q: q).body)
+    end
+  end
+
+end

data/lib/journey/version.rb

@@ -2,7 +2,7 @@ module Journey
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/spec/models/journey/resource_spec.rb

@@ -63,4 +63,38 @@ describe Journey::Resource do
       end 
     end
   end
+
+
+  describe '::Search' do
+    it 'returns matching objects when matches are made' do
+      uuid = SecureRandom.uuid
+
+      matched_objects = [
+        klass.create(name: "#{SecureRandom.uuid}#{uuid}"),
+        klass.create(name: "#{SecureRandom.uuid}#{uuid}")
+      ]
+      expect(matched_objects.all?(&:persisted?)).to be true
+
+      unmatched_objects = [
+        klass.create(name: "#{SecureRandom.uuid}"),
+        klass.create(name: "#{SecureRandom.uuid}")
+      ]
+      expect(unmatched_objects.all?(&:persisted?)).to be true
+
+      searched_objects = klass.search(uuid)
+
+      matched_objects.each do |object|
+        expect(searched_objects).to include(object)
+      end
+
+      unmatched_objects.each do |object|
+        expect(searched_objects).not_to include(object)
+      end
+    end
+
+    it 'returns an empty array when no matches are made' do
+      results = klass.search(SecureRandom.uuid)
+      expect(results).to_not be_any
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
 require 'pry'
 require 'journey'
 
+
 require 'dotenv'
 Dotenv.load
 
+require 'factory_girl'
+
 Dir["spec/support/**/*.rb"].each { |f| require "./#{f}" }
 
 RSpec.configure do |config|

data/spec/support/test_configuration.rb

@@ -5,6 +5,5 @@ module TestConfiguration
       c.api_user = ENV['JOURNEY_API_USERNAME']
       c.api_password = ENV['JOURNEY_API_KEY']
     end
-    binding.pry
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embark-journey
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dan Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/journey/resource/attribute_loading.rb
 - lib/journey/resource/enums.rb
 - lib/journey/resource/queries.rb
+- lib/journey/resource/search.rb
 - lib/journey/version.rb
 - spec/models/journey/configurable_spec.rb
 - spec/models/journey/configuration_spec.rb