<commit_before>{<img src="https://travis-ci.org/Shopify/asset_cloud.png?branch=master" alt="Build Status" />}[https://travis-ci.org/Shopify/asset_cloud]

= AssetCloud

An abstraction layer around arbitrary and diverse asset stores.

== Value Hash vs Checksum

+value_hash+ is intended as a *private* hash/checksum, not exposed to end users. Its underlying algorithm is private, and
could change over time so should not be relied on by clients.

+checksum+ is intended as a *public* hash/checksum, exposed to end users. Its underlying algorithms is documented (e.g. MD5)
and is not expected to change.

== Installation

=== as a Gem

    gem install asset_cloud

== Testing

   dev test

With S3 Remote test:

    AWS_ACCESS_KEY_ID="<s3_key>" AWS_SECRET_ACCESS_KEY="<s3_secret_key>" S3_BUCKET_NAME="<bucket_name>" bundle exec rake spec

With GCS Remote test:

    GCS_PROJECT_ID="<project_id>" GCS_KEY_FILEPATH="<path_to_key>" GCS_BUCKET="<bucket_name>" bundle exec rake spec

== Copyright

Copyright (c) 2008-2014 <NAME> & Shopify, Inc. Released under the MIT license (see LICENSE for details).<commit_msg>Add contributing docs with release instructions<commit_after>{<img src="https://travis-ci.org/Shopify/asset_cloud.png?branch=master" alt="Build Status" />}[https://travis-ci.org/Shopify/asset_cloud]

= AssetCloud

An abstraction layer around arbitrary and diverse asset stores.

== Value Hash vs Checksum

+value_hash+ is intended as a *private* hash/checksum, not exposed to end users. Its underlying algorithm is private, and
could change over time so should not be relied on by clients.

+checksum+ is intended as a *public* hash/checksum, exposed to end users. Its underlying algorithms is documented (e.g. MD5)
and is not expected to change.

== Installation

=== as a Gem

    gem install asset_cloud

== Testing

   dev test

With S3 Remote test:

    AWS_ACCESS_KEY_ID="<s3_key>" AWS_SECRET_ACCESS_KEY="<s3_secret_key>" S3_BUCKET_NAME="<bucket_name>" bundle exec rake spec

With GCS Remote test:

    GCS_PROJECT_ID="<project_id>" GCS_KEY_FILEPATH="<path_to_key>" GCS_BUCKET="<bucket_name>" bundle exec rake spec

== Releasing

Releasing is handled by Shopify's internal Shipit server.

After merging a change, a separate PR should be opened to update `History.md` and bump the version
(following [Semantic Versioning](https://semver.org/))

When merged, the new release will be automatically tagged and deployed to rubygems.org.

Note that the automatic process does not create a new [release](https://github.com/Shopify/asset_cloud/releases) on
GitHub.

== Copyright

Copyright (c) 2008-2014 <NAME> & Shopify, Inc. Released under the MIT license (see LICENSE for details).
{'fraction_non_alphanumeric': 0.09449404761904762, 'fraction_numerical': 0.009672619047619048, 'mean_word_length': 4.975555555555555, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1005464', 'n_tokens_mistral': 856, 'n_tokens_neox': 826, 'n_words': 301}