# LeapSalesforce

Welcome to LeapSalesforce gem. This gem helps ones to perform integration tests on Salesforce. It reads the Metadata
from Salesforce and creates the foundation for API tests. 

In the future it will also planned to be used to create page objects based on metadata to support UI testing. 

[![Build Status](https://gitlab.com/leap-dojo/leap_salesforce/badges/master/build.svg)](https://gitlab.com/leap-dojo/leap_salesforce/pipelines)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'leap_salesforce'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install leap_salesforce

## Usage
### Getting started
After installing the gem, to get started in creating a fresh repository, the `leap_salesforce` executable can be used.
It will ask for credentials and setup files that will locally store them. 
This assumes that a Salesforce OAuth app be set up to be used for the API which can be done by 
following [this wiki]('https://gitlab.com/leap-dojo/leap_salesforce/wikis/SetUpOAuthApp').

E.g

```
leap_salesforce init
```

Credentials are not stored in stored in source control. They can be setting through the following environment variables:

* 'client_id'
* 'client_secret'
* 'password'

Tests can be run using the default `Rake` task.

E.g.,

`rake` # Run all tests

API Traffic logs can be seen in the `logs` folder.

TODO: Finish this. A lot more needed

## Docs

Technical docs [here](https://www.rubydoc.info/gems/leap_salesforce)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://gitlab.com/leap-dojo/leap_salesforce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the LeapSalesforce project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/leap-dojo/leap_salesforce/blob/master/CODE_OF_CONDUCT.md).

# Examples

```ruby
# deleting old contacts
objects = Contact.each_id_with CreatedDate: "<#{5.days.ago}"
puts objects.count
objects.each do |id|
  puts "Deleting #{id}"
  Contact.delete id
end 
```